Employee Spotlight
Community Edition Documentation
Author: eMarket Design
Last Updated: 2018-04-05
Introduction
Employee Spotlight is a starter plugin to showcase your employees, staff, team members, founders or just yourself on your WordPress site.
Concepts
The following is the definition(s) of the concept(s) covered in the context of Employee Spotlight app:
Last Updated: 2015-04-17
Employees
Employees are human resources that work for your organization. Employees can be identified as staff, team members, founders, or contractors.
Last Updated: 2017-08-23
Quick Start
Employee Spotlight Community Introduction
Watch Employee Spotlight Community introduction video to learn about the plugin features and configuration.
Best Employee Profile Management Plugin - Employee Spotlight Pro
Protect and enhance your brand's reputation with the best WordPress plugin.
Used by many prominent companies around the world, Employee Spotlight Pro offers enterprise features not available anywhere else. Easy to use, powerful and beautiful ways to showcase your talent.
EMD CSV Import Export Addon helps you get your data in and out of WordPress quickly, saving you ton of time
EMD CSV Import Export Addon helps bulk import, export, update entries from/to CSV files. You can also reset(delete) all data and start over again without modifying database. The export feature is also great for backups and archiving old or obsolete data.
Smart Search Addon for finding what's important faster
Smart Search Addon for Employee Spotlight Community edition helps you:
Filter entries quickly to find what you're looking for
Save your frequently used filters so you do not need to create them again
Sort entry columns to see what's important faster
Change the display order of columns
Enable or disable columns for better and cleaner look
Export search results to PDF or CSV for custom reporting
EMD Active Directory/LDAP Extension helps bulk import and update Employee Directory data from LDAP
EMD Active Directory/LDAP Extension helps bulk importing and updating Employee Directory data by visually mapping LDAP fields. The imports/updates can scheduled on desired intervals using WP Cron.
Working with Employees
Using Employee Spotlight, you can create, modify, delete, and search employee records, associated taxonomies, or relationships.
Last Updated: 2018-04-05
Creating Employees
To create employee records in the admin area:
Log in to your Administration Panel.
Click the 'Employees' tab.
Click the 'Add New' sub-tab or the “Add New” button in the employee list page.
Start filling in your employee fields. You must fill all required fields. All required fields have red star after their labels.
As needed, set employee taxonomies and relationships. All required relationships or taxonomies must be set.
When you are ready, click Publish. If you do not have publish privileges, the "Submit for Review" button is displayed.
After the submission is completed, the employee status changes to "Published" or "Pending Review". Users must have "publish" right to publish employees. Users who do not have "publish" right can still create employees; however, these employees must be reviewed and approved by a user with employee "publish" right. Check Roles and Responsibilities section of this document to see which access groups have employee "publish" right.
Last Updated: 2015-05-24
Modifying Employees
Employees can be modified by clicking on the "Edit" link under the employee title in the employee list page in the admin area. Make any necessary changes and then click Publish.
Last Updated: 2015-05-24
Searching Employees
In Employee Spotlight, users are only allowed to search employees they have access to. Users who have access to employees can search using the filter system in the employee admin area.
Last Updated: 2015-05-24
Scheduling Employees
To schedule Employees for publication on a future time or date in the admin area:
Log in to your Administration Panel.
Click the 'Employees' tab.
Click the 'Add New' sub-tab or the “Add New” button in the employee list page.
Start filling in your employee fields. You must fill all required fields. All required fields have red star after their labels.
As needed, set employee taxonomies and relationships. All required relationships or taxonomies must be set.
When you are ready, click "Edit" in the Publish area next to the words "Publish immediately". You can also change the publish date to a date in the past to back-date Employees. Change the settings to the desired time and date. You must also hit the "Publish" button when you have completed the employee to publish at the desired time and date.
After the submission is completed, the employee status changes to "Published".
Last Updated: 2015-05-24
Password Protected Employees
To create a password protected employee in the admin area:
Log in to your Administration Panel.
Click the 'Employees' tab.
Click the 'Add New' sub-tab or the “Add New” button in the employee list page.
Start filling in your employee fields. You must fill all required fields. All required fields have red star after their labels.
As needed, set employee taxonomies and relationships. All required relationships or taxonomies must be set.
Click the "Edit" link next to Visibility in the publish box and select "Password protected".
Enter a password that will be required to view that employee in the text field. The password is limited to 20 characters.
When you are ready, click the "Publish" button (or "Update" if the employee is already published.)
After the submission is completed, the employee status changes to "Published".
Only an Administrator and users with "publish" right can change the password set for your employee or modify visibility setting by clicking the "Visibility: Edit" link again.
When employee content is password protected, employee title displays the text "Protected: " before the employee Title and the content prints a password form with this text: "This content is password protected. To view it please enter your password below:".
If multiple employees have the same password, one will only have to enter the required password once. Only one password is tracked at a time so if you visit two different employees with two different password, you must re-enter the employee password to access content. WordPress saves passwords for maximum 10 days. After this period expires, one must reenter the password again to view the protected content.
Last Updated: 2015-05-24
Private Employees
Employees can be privately published to remove them from employee lists and feeds.
To create a private employee in the admin area:
Log in to your Administration Panel.
Click the 'Employees' tab.
Click the 'Add New' sub-tab or the “Add New” button in the employee list page.
Start filling in your employee fields. You must fill all required fields. All required fields have red star after their labels.
As needed, set employee taxonomies and relationships. All required relationships or taxonomies must be set.
Click the "Edit" link next to Visibility in the publish box and select "Private".
Once you change the visibility to private, the employee status changes to "Privately Published".
When you are ready, click the "UPDATE" button.
Only an Administrator and users with "publish" right for the employee can change visibility setting by clicking the "Visibility: Edit" link again.
Last Updated: 2015-04-17
Previewing Employees
To preview employee content press the "Preview" button - a button directly above the “publish” button - in the publish box before officially publishing or sending for review.
Last Updated: 2015-04-17
Draft Employees
To create a draft employee in the admin area:
Log in to your Administration Panel.
Click the 'Employees' tab.
Click the 'Add New' sub-tab or the “Add New” button in the employee list page.
Start filling in your employee fields. You must fill all required fields. All required fields have red star after their labels.
As needed, set employee taxonomies and relationships. All required relationships or taxonomies must be set.
When you are ready, click "Save Draft" button in the publish box.
After the submission is completed, the employee status stays at "Draft".
Last Updated: 2016-10-25
Employee Author
Once the employee is published the user who created the employee is assigned as the employee author. Employee authors can view and edit the employee. One can change the employee author from the author box. The author box drop down is limited to the users who have employee "publish" right.
Last Updated: 2016-10-25
Creating Custom Fields
Employee Spotlight Community supports creating of custom fields. Creating of custom fields provides a quick way to allow you to extend the content with key/value pairs also known as meta data. Custom fields store arbitrary extra information about employees.
To create a custom fields for your employees
Edit any employee or create a new one in the admin area. You will see the Custom Fields metabox. if you do not see it, enable it from Screen options.
Creating a custom field requires a key and a value. The key is constant, but the value can change for each employee. Click on Enter New link or select a key from the dropdown list.
Enter a value and click Add Custom Field button
Repeat the steps above for creating more fields
You can create as many custom fields as you need. If your custom field key may have multiple values, create a new field and use the same key with different values. You can use HTML code in the value box. Employee Spotlight concatenates each value separated with a space character. By default, WordPress shows 30 custom fields in the dropdown list.
Once you create employee custom fields, they are displayed in the frontend.
Last Updated: 2016-10-25
Setting Employee Tags
Employee Tag can be set by typing the desired option in the empty text field and clicking "Add" button in "Employee Tags" box and updating/saving the employee. Setting a value for Employee Tag is optional. Employee Tag is also not organized hierarchically meaning there's no relationship from one Employee Tag value to another.
Employee Tags do not have preset values.
Last Updated: 2015-04-17
Setting Groups
Group can be set by typing the desired option in the empty text field and clicking "Add" button in "Groups" box and updating/saving the employee. Setting a value for Group is optional. Group is also not organized hierarchically meaning there's no relationship from one Group value to another.
Groups do not have preset values.
Last Updated: 2015-04-17
Setting Locations
Location can be set by typing the desired option in the empty text field and clicking "Add" button in "Locations" box and updating/saving the employee. Setting a value for Location is optional. Location is also not organized hierarchically meaning there's no relationship from one Location value to another.
Locations do not have preset values.
Last Updated: 2015-04-17
Displaying Employees
Displaying Employee archives can be done by creating a link in the Appearance Menus Screen in the admin area.
Alternatively, if you'd like to display a specific Employee, you can select the link from Employee metabox and add it to your menu. If you don't see Employee metabox, check the Screen Options to ensure it is set to display.
To create a custom link for Employee archives:
Goto Appearance in the admin menu and click on Menus link
On the right hand side, pick the menu you’d like to include from Select a menu to edit dropdown
Under Links menu navigation item, type in /employees to the URL field
Type in Employees or another label describing the custom link URL in the Link Text field
Click “Add to menu” button to add the item to the menu
Pick “primary location” under “Menu Settings” below the menu
Save your menu
Go to the frontend and click on the link you created to access Employees. Employee archive page content is only displayed to the authorized users who have access permissions.
Last Updated: 2015-04-17
Locking Employees
In Employee Spotlight, Employees are locked during editing, preventing other users from accessing and modifying the Employee.
If a user clicks to edit one of the Employee records that's currently locked they are presented with three options in a pop-up dialog:
Go Back - Return to the Employees listing.
Preview - Preview the current state of the Employee that's being edited.
Take Over - Lock out the current editor of the Employees and begin editing. (The other user will receive a notification)
The user that has been locked out receives the following dialog, and is no longer able to edit the Employee. It can take up to 15 seconds for the current Employee editor to be notified that another user has taken over.
Widgets
Widgets provide a simple and easy-to-use way of displaying content and features on your sidebars or dashboard.
Sidebar widgets can be added, removed, and rearranged on the WordPress Administration Appearance > Widgets panel. Dashboard widgets can be enabled or disabled using Screen Options tab in your app dashboard page. All widgets have drag-and-drop functionality.
The following sections list the Employee Spotlight widgets:
Last Updated: 2015-04-17
Featured Employees sidebar widget
Featured Employees is an entity sidebar widget. It shows latest 5 published employee records without any page navigation links.
Last Updated: 2015-04-17
Recent Members sidebar widget
Recent Members is an entity sidebar widget. It shows latest 5 published employee records without any page navigation links.
Standards
Standard views display a single type of content in a custom format and can be used in place of archive views. Administrators can display standard views using their shortcodes by choosing the name of the view you want to display from the WPAS component list after clicking on the WPAS toolbar button on any page.
The following sections list the Employee Spotlight standard views available:
Last Updated: 2016-10-25
Employee Circle Grid
"Employee Circle Grid" is a standard view which displays 12 Employee records per page with a post status of publish in descending order by date. Page navigation is enabled. If you choose to install setup pages during plugin activation, a WordPress page is created with a title of "Employee Circle Grid". You can visit this page to access the view. To display it in another page or post, use [employee_circle_grid] shortcode or select the view name from the WPAS component list after clicking on the WPAS toolbar button.
Last Updated: 2016-10-25
Employee Circle Panel Grid
"Employee Circle Panel Grid" is a standard view which displays 12 Employee records per page with a post status of publish in descending order by date. Page navigation is enabled. If you choose to install setup pages during plugin activation, a WordPress page is created with a title of "Employee Circle Panel Grid". You can visit this page to access the view. To display it in another page or post, use [employee_circle_panel_grid] shortcode or select the view name from the WPAS component list after clicking on the WPAS toolbar button.
Last Updated: 2017-07-31
Roles and Capabilities
The following table shows the capabilities and the access roles available in Employee Spotlight app. "Red" color means the users who belong to the corresponding role do not have the capability. "Green" color means the users who belong to the corresponding role have the capability.
Plugins are managed from the Plugins screen in the Administration Screens of your WordPress site. All Plugins listed on this screen are found in your wp-content/plugins directory. Each Plugin has a description in its header section of what it does, an author and website to refer to, and a version number. Find Employee Spotlight from the list.
Last Updated: 2016-10-25
Installation
To install your Employee Spotlight Plugin using the built-in plugin installer:
Download Employee Spotlight Plugin to your desktop.
Go to Plugins "Add New".
Under Upload, click "Browse".
Find the employee-spotlight-community-VERSION.zip file.
Click Install Now to install the Employee Spotlight Plugin.
A popup window will ask you to confirm your wish to install the Plugin.
Click Proceed to continue with the installation. The resulting installation screen will list the installation as successful or note any problems during the install.
If successful, click Activate Plugin to activate it, or Return to Plugin Installer for further actions.
Replace VERSION in instructions with the version number of Employee Spotlight you want to install. After the activation, the Employee Spotlight plugin setup may display notification asking if you if you'd like to install setup pages or skip setup page installation, click the appropriate button.
Last Updated: 2015-04-17
Uninstallation
To uninstall your Employee Spotlight Plugin using the built-in plugin installer:
Go to Plugins screen.
Find the Employee Spotlight Plugin you wish to deactivate and uninstall.
Click Deactivate.
Last Updated: 2016-10-25
Plugin Updates and Upgrades
WordPress auto-update system displays notification in the Admin Bar and also on the plugins page when new version of the Employee Spotlight is available.
To install the new version, simply hit the "Update automatically" button. WordPress will automatically download the new package, extract it and replace the old files. No FTP, removing old files, and uploading is required.
Upgrading your plugin
We offer different plugin editions to better match your needs. If you purchased a different edition of Employee Spotlight, follow the steps below to upgrade your plugin:
Go WordPress plugins page and deactivate and optionally delete the current Employee Spotlight Community edition.
Install the new edition based on the instructions in WordPress Codex
Activate the new edition
Go to Plugin Settings page and save settings
Upgrading Employee Spotlight Community edition does not have any impact on your existing data but it is always a good idea to back up your WordPress database as a rule of thumb before any changes.
Using Plugin Extensions
Employee Spotlight Community edition is configured to work with many plugin extensions. Most plugin extensions work regardless of the edition unless specified specifically in the plugin page.
if you purchased a plugin extension, follow the instructions in WordPress Codex to install and activate your plugin extension like any other WordPress plugin.
If your extension comes with a license key, you must save and activate your license key to get software updates and support.
Last Updated: 2018-04-05
Setting Global Options
Administrators can set global options available for Employee Spotlight. After logging in as administrator, click Settings page under Spotlight menu. Modify the ones you want to be changed and click Save button to make changes active. The following lists the available options:
Image Border Color
Sets the color of image border. If you put in "rgba(0, 0, 0, 0)" (without quotes), it will not display border.
Last Updated: 2016-10-25
Changing Entity Base Slug
The default entity base slug can be changed within entity tab of settings page in Spotlight menu. After you update, make sure to refresh your site's Permalinks under Settings. You can only change base slug if post name based permalink structure is selected.
Last Updated: 2018-04-05
Resolving theme related conflicts
For the most part, Employee Spotlight templates will integrate nicely with most WordPress themes. However you may run into issues when the default Employee Spotlight content wrappers do not match your chosen theme or your theme's CSS rules overwrite Employee Spotlight CSS rules.
Theme related issues manifest themselves by;
Breaking your layout on Employee Spotlight pages and shifting your sidebars into incorrect positions
Some random text getting displayed in header or footer of your site
Some sections in plugin pages not getting displayed as in the plugin's demo site.
Theme related issues can potentially affect all single, taxonomy, archive and shortcode pages because Employee Spotlight uses templates of its own to display these pages and it’s impossible for eMDPlugins to know exactly what markup or CSS rules your theme uses.
The following is a Developer level documentation. If you’re unfamiliar with code/templates and resolving potential conflicts, we strongly suggest to hire us or a developer to complete the project for you. Please also note that our complimentary support team is unable to assist with customization per our Support Policy.
There are three methods to resolve theme related issues;
Copying and modifying your theme's header.php and footer.php
Copying and modifying your theme's page.php
Adding custom CSS rules
Modifying header.php and footer.php
Go to your theme's folder -- wp-content/themes/YOURTHEME/
Copy header.php of your theme as header-emdplugins.php
Copy footer.php of your theme as footer-emplugins.php
Remove the conflicting code from header-emdplugins.php and/or footer-emplugins.php.
This will make Employee Spotlight use these newly created header and footer instead of your theme's default header and footer. Save the files. You’re done.
Copying and modifying your theme's page.php
If the issue can not be resolved through simply modifying the header and footer templates, you need to modify your theme's page.php.
Please note that this approach eliminates Your ability:
To set page templates for single, archive and taxonomy pages
To remove page navigation from archive and taxonomy pages.
from Spotlight, settings page.
To set up this template page:
Duplicate your theme’s page.php file, and name it employee-spotlight.php. This file should be found like this: wp-content/themes/YOURTHEME/employee-spotlight.php.
Open up your newly created employee-spotlight.php in a text editor, or the editor of your choice.
Next you need to find the loop (see The_Loop). The loop usually starts with a:
<?php if ( have_posts() ) :
and usually ends with:
<?php endif; ?>
This varies between themes. Once you have found it, delete it. In its place, put:
<?php employee_spotlight_content(); ?>
This will make your theme use Employee Spotlight’s loop instead. Save the file. You’re done.
Adding CSS rules
You add custom CSS rules in the Custom CSS field of Tools tab under Spotlight menu, settings page to overwrite your theme's default CSS. The custom css rules added in the settings are not deleted when your plugin gets updated.
You can learn CSS language by completing the tutorials at w3schools.com
Last Updated: 2018-04-05
Localization(l10n)
Employee Spotlight can be translated into any language by editing employee-spotlight-emd-plugins.pot and employee-spotlight.pot files.
employee-spotlight-emd-plugins.pot file is for the components used in Employee Spotlight.
employee-spotlight.pot file is for the Employee Spotlight specific strings that need to be translated.
Follow the steps below to fully translate Employee Spotlight into the desired language:
Copy employee-spotlight-emd-plugins.pot as language specific .po file such as employee-spotlight-emd-plugins-tr_TR.po.
Copy employee-spotlight.pot as language specific .po file such as employee-spotlight-tr_TR.po.
Use your favorite PO file editor and complete translation strings in the .po files you created.
When translations are completed, create .mo file of each .po file.
Put translated .mo files and .po files in the directory above to protect them from getting deleted during plugin updates.
Change the language to the translated language from Settings > General > Site Language.
Repeat the process until you get all strings translated
.
Last Updated: 2015-04-17
Screen Options
Screen Options is displayed as a hanging tab under the toolbar. Click on the Screen Options tab to expand the options available for a particular Screen, check (or uncheck) the desired options, then click the Screen Options hanging tab to collapse the Screen Options. Each screen may have a different set of Screen Options.
Edit page screen options allow the user to decide the edit boxes ,such as taxonomies, relationships or specific boxes such as authors, are presented in the edit area. You can turn on and off the ones that are not needed for a particular edit session.
List page screen options allow users to set the number of records displayed in the list table.
Last Updated: 2018-04-05
Creating Shortcodes
Shortcodes are small blocks of reusable code that can be inserted in a page to generate dynamic and often complex functionality. There is no limit in number of shortcodes that can be created and used. Multiple shortcodes can be used in the same page.
Examples
The following shortcode creates a Employee Circle Grid page with employees of Employee Tags category.
The following shortcode creates a Employee Circle Grid page with the published employees of Employee Tags category where Featured is emd_employee_featured in descending order by comment count, displaying 15 employees with no pagination.
Note: Replace YOUR ATTRIBUTE VALUE with the value stored for that attribute and YOUR TAXONOMY VALUE with the slug of the corresponding taxonomy value.
Last Updated: 2018-04-05
Customizations
Employee Spotlight offers extensive customization options from plugin settings, settings page. The following customizations can be done without changing your theme's template files:
Enable or disable all fields, taxonomies and relationships from backend and/or frontend
Set any entity and/or archive base slug
Set the page template of any entity, taxonomy and/or archive page to sidebar on left, sidebar on right or no sidebar (full width)
Hide the previous and next post links on the frontend for single posts
Hide the page navigation links on the frontend for archive posts
Display or hide any custom field
Display any side bar widget on plugin pages using EMD Widget Area
Set custom CSS rules for all plugin pages including plugin shortcodes
If your customization requirements are more complex and can not be resolved through the list of options provided above, you need to implement advanced customization techniques.
Advanced Customizations
Note:The following is a Developer level documentation. If you’re unfamiliar with code/templates/localization and resolving potential conflicts, we strongly suggest to hire us or a developer to complete the project for you. Please also note that our complimentary support team is unable to assist with customization per our Support Policy.
Employee Spotlight advanced customization can be done on 3 different areas;
Look & Feel - changing layout and overall presentation of content
Functionality - adding, deleting or modifying existing plugin functionality
Strings - changing the field names
Plugin customization can be implemented by using 4 different methods:
If you'd like to modify the functionality, you need to modify the plugin design (sold separately) using WP App Studio ProDev API access (sold separately and monthly development plans are available).
If you like to customize how HTML elements are to be displayed on screen, you can add custom CSS rules with higher specificity to your theme's style.css file.
If you'd like to customize layouts of Employee Spotlight, Please follow the steps below:
Create "emd_templates" directory under your theme's directory.
Copy the layout files that you want to customize into "emd_templates" directory which you created in step 1 from PLUGIN-ROOT/layouts directory
Modify the file based on your needs
The layout files you added in the "emd_templates" has always precedence over the plugin's layout files. If the customized files get deleted, the layouts which came with your plugin are displayed. We recommend that you create a child theme if you'd like to minimize the risk of accidental deleting of the "emd_templates" directory because of theme updates.
The following layout file types can be customized:
Single view page
Archive view page
Taxonomy view page
Search form result page
Standard list page
Integration page
Org chart record and tooltip layout page
Customizing strings
Employee Spotlight labels and messages can be customized to better match your needs through language files. The customization is very similar to localization but recommended for US English users only. If your language is different than US English, you should localize instead of customize. The customization can be done for the strings included in employee-spotlight-emd-plugins.pot and employee-spotlight.pot files.
The following steps cover the string customization of labels and messages.
employee-spotlight-emd-plugins.pot file is for the translatable strings of components used in Employee Spotlight.
employee-spotlight.pot file is for the Employee Spotlight specific strings that need to be translated.
Follow the steps below to fully customize Employee Spotlight labels and messages:
Copy employee-spotlight-emd-plugins.pot as language specific .po file such as employee-spotlight-emd-plugins-en_US.po.
Copy employee-spotlight.pot as language specific .po file such as employee-spotlight-en_US.po.
Use your favorite PO file editor or plugin and complete customization of strings in the .po files you created.
When customization are completed, create .mo file of each .po file.
Put customized .mo files and .po files in the directory above to protect them from getting deleted during plugin updates.
Repeat the process until you get all strings customized. If you do not need a string to be customizes, leave it as it is.
All customization can be done by yourself or emarketdesign.com. Open a support ticket, if you prefer us to do the customization for you.
Glossary
Below is the list of attribute and taxonomy definitions.
Last Updated: 2018-04-05
Employee
Employees are human resources that work for your organization. Employees can be identified as staff, team members, founders, or contractors.
Featured
Sets employee as featured which can be used to select employees in available views using Visual Shortcode Builder and Featured employee widget. Featured does not have a default value.
Photo
Photo of the employee. 250x250 is the preferred size. Photo does not have a default value.
Job Title
Job Title does not have a default value.
Primary Address
Primary Address does not have a default value.
Phone
Phone is filterable in the admin area. Phone does not have a default value.
Mobile
Mobile is filterable in the admin area. Mobile does not have a default value.
Email
Email does not have a default value.
Facebook
Facebook does not have a default value.
Google+
Google+ does not have a default value.
Twitter
Twitter does not have a default value.
Linkedin
Linkedin does not have a default value.
Github
Github is filterable in the admin area. Github does not have a default value.
Bio
Bio does not have a default value.
Full Name
Full Name is a required field. Being a unique identifier, it uniquely distinguishes each instance of Employee entity. Full Name is filterable in the admin area. Full Name does not have a default value.
Excerpt
Excerpt does not have a default value.
Birthday
Birthday is filterable in the admin area. Birthday does not have a default value.
Last Updated: 2018-04-05
Globals
Global attributes can be set in the Settings page, Global tab under Spotlight menu.
Image Border Color (text)
Sets the color of image border. If you put in "rgba(0, 0, 0, 0)" (without quotes), it will not display border.