Staff Directory

Documentation

Staff Directory Guide

Installation  

A Staff Directory page is created on install and automatically filled with a Staff Directory List block.
Do not delete this page as this is where staff directory items will live.

You may hide it from navigation if you prefer to add Staff Directory List block to another page. See section below titled "Adding a New Directory Section" for details on doing this.


Adding a New Staff Directory Item

  1. A New Staff Directory item can be added by clicking the Add/Edit link under Dashboard >> Staff Directory or by clicking on the “Add New” button from the View/Search page.
  2. Fill out all of the required fields (indicated by an asterisk*) under the Basic Information tab. There are optional fields that provide further content when filling out your directory. These fields have been grouped in a tabular format. Available tabs are:

·       Additional Information

·       Images

·       Options

·       Meta

  1. Click "Add" to save your directory item information.


Editing an Existing Staff Directory Item

  1. Go to Dashboard >> Staff Directory
  2. Click on the View/Search link.
  3. Find your Staff Directory item and click the edit icon or the name of your staff directory item.
  4. Update fields on the page.
  5. Click "Update" to save your changes to the Staff Directory item.


Hiding Your Staff Directory Item from the Public View

  1. Find and click into your Staff Directory item.
  2. Click on the "Options" tab and click “Exclude From Page List” under the Hidden From Public header.
  3. Click "Update" to save your directory item.


Adding a New Directory Section

Example Scenarios: Suppose you want to give some visual distinction to differnent departments using staff directory, by creating a "Section" on a separate page.

  1. By default we have Staff Directory page as a single directory section. To add a new you can add a page as we normally do in sitemap.
  2. Go to the attributes of the page and select the attribute "Directory Section" to yes.
  3. Now when you will add/edit a new staff directory all the sections will present in the section dropdown, you can select section you want the directory to be present below.
  4. While adding the listing block to a page you can also select that which sections directory you want to list there.


Adding Images to Your Staff Directory Item

  1. Go to Dashboard >> Staff Directory
  2. Click on the View/Search link.
  3. Click on the "Images" tab.
  4. There are 2 image upload options available. 

·       Thumbnail image is used for the listing page

·       Main image is used for the detail page

  1. Keep in mind when uploading your images that the sizes should complement your site. However, the image size will scale accordingly.


Increasing SEO for Your Site

  1. Find and click into your directory item.
  2. Click on the "Meta" tab.
  3. Input your Meta information for Meta Title, Meta Description, and Meta Keywords.
  4. Click "Update".


Adding/Editing Staff Directory Department/Type

  1. Go to Dashboard >> Staff Directory
  2. Click on the Add New Department/Type link.
  3. Scroll and find the existing attributes under “Values”. You can edit or delete them. Also, you can fill out the textbox, then click “Add”. Remember to click on the ‘Save’ button to update your changes.
  4. IMPORTANT NOTE: If you have edited OR deleted a Department/Type, you need to manually sync the changes to your Staff Directory items (Concrete5 does not automatically do this. To make the update process easier, we have created a button to refresh all Staff Directory items). To refresh the changes, click on the “Refresh Department/Type” button on the Staff Directory >> View/Search page.


Adding the Staff Directory List to a Page

  1. Click on any block area from the user side of your site.
  2. Click “Add Block”.
  3. Find the Staff Directory List block and click on it.
  4. Select Edit Block and choose from the available options to configure your block.
  5. Available options include:

a)    Pagination : You can set the pagination count from here.

b)    Select Department/Type : This feature will display only those staff members that will meet the criteria of the selected Department/Type.

c)    Display Order : This develops the pattern you would like to see the data on the web page. It consists of the following options:

●      Sitemap Ascending

●      Newest

●      Oldest

●      Alphabetical by First Name

●      Alphabetical by Last Name

●      Random Order

d)    Include Keyword Search : A keyword search box will be included to the listing page.

e)    Include Export to Excel : An export to Excel button will be added to the listing page.

f)     Display: Select information to display for the Staff Directory Item. Options include:

●    Department/Type

●    Position/Title

●    Phone

●    Email

  1. Click "Add" OR “Save” if in Edit mode.


Change Staff Directory List View Template

The Staff Directory includes 3 different custom templates for the listing page:

  1. Directory A To Z View
  2. Directory Card View
  3. Directory Grid View


To change the listing page template:

  1. Visit the page of the directory item you want to edit.
  2. Enter “Edit” Mode.
  3. Click on the block area and click "Design & Custom Template".
  4. Click on the gear symbol in the tool bar that appears.
  5. Select one of the available templates from the Custom Template dropdown menu and click "Save" at the top.

 

Change your Directory Item's Detail Page Layout

The Staff Directory includes eight different templates for the detail page:

1.    Left photo/contact; list Info

2.    Left photo/contact; tabbed info

3.    Right photo/contact; list info

4.    Right photo/contact; tabbed info

5.    Banner image; left contact; list info

6.    Banner image; left contact; tabbed info

7.    Banner image; right contact; list info

8.    Banner image; right contact; tabbed info

 

 

To change the detail page template:

  1. Go to Dashboard.
  2. Click on Staff Directory.
  3. Click on Settings.
  4. Select one of the available templates from the Default Profile Layout dropdown menu.

If you have your caching enabled, you will need to clear it before you will see these changes. 

Note: Limitations may exist when adding more than one Staff Directory block to a single page. For best results, we recommend limiting use to one Staff Directory block per page.

 

To enable the module's inclusion in the site-wide core search:

  1. You can do this by going to Pages & Themes -> Attributes.

  2. Once there, scroll down to the section on "Staff Directory" and find what field you're aiming to activate for searching (name, bio, etc). Click to open.

  3. When viewing the attribute detail page, you'll find a checkbox labeled "Content included in search index." Select that and save the record. 

  4. That field is now added to the targeted fields within the C5 search function.  

 

 

To setup automated Job when CMS version of Concrete5 is 9 and above.

  1. You can go to Dashboard > System & Settings > Optimization > Automated Jobs
  2. Select Job Sets tab.
  3. Click on Add Job Set.
  4. Add the name for Ex. “Staff Directory Import”
  5. Select the checkbox “Staff Directory Import” from “Jobs”.
  6. Select “Run job set through cron”.
  7. Then you can use the scheduled URL that would be generated.

To setup Task for Concrete5 version 9 and above.

 

  1. You can go to Dashboard > System & Settings > Automation > Automation Settings
  2. Make sure the scheduler is enabled
  3. Then go to Dashboard > System & Settings > Automation > Tasks
  4. Search for “Staff Directory Import Task” and select the task
  5. Scroll to the bottom of the page under “Run Task”, select “schedule recurring task”.
  6. Set the cron expression to set the time at which the cron should run and click on “Run Task”. You can take reference from the following URL: https://crontab.guru/
  7. You should see the task as scheduled under “Schedule”
    image 
  8. Once all the above is setup the scheduling worker needs to be setup in crontab.
    1. Go to your web root folder.
    2. Under crontab where you have setup all crons for the site. Add the following command and ensure that the scheduling worker runs every minute.
      * * * * * cd /path/to/project/directory && php /path/to/public/concrete/bin/concrete concrete:scheduler:run > /dev/null 2>&1
    3. Also make sure the php file is executable.