Fairsail WX Configuration Guide
Version 18.05
© Fairsail 2017. All rights reserved.
This document contains information proprietary to Fairsail and may not be reproduced, disclosed, or used
in whole or in part without the written permission of Fairsail.
Software, including but not limited to the code, user interface, structure, sequence, and organization, and
documentation are protected by national copyright laws and international treaty provisions. This document
is subject to U.S. and other national export regulations.
Fairsail takes care to ensure that the information in this document is accurate, but Fairsail does not
guarantee the accuracy of the information or that use of the information will ensure correct and faultless
operation of the service to which it relates. Fairsail, its agents and employees, shall not be held liable to or
through any user for any loss or damage whatsoever resulting from reliance on the information contained
in this document.
Nothing in this document alters the legal obligations, responsibilities or relationship between you and
Fairsail as set out in the contract existing between us.
This document may contain screenshots captured from a standard Fairsail system populated with fictional
characters and using licensed personal images. Any resemblance to real people is coincidental and
unintended.
All trademarks and service marks mentioned in this document belong to their corresponding owners.
FS-WX-XXX-CG-201704--R018.05
Fairsail WX Configuration Guide
© Fairsail 2017
2
Contents
Contents
About this Guide 6
Related Guides 6
Feedback 7
Introduction 8
Fairsail Processes in this WX Release 11
Browser Compatibility 14
Moving End Users From Collaboration Portal To WX 15
Upgrading to the Latest WX Release 16
Modify Page Layout: Existing WX Services 17
Modify Page Layout: No Existing WX Services 19
Modify Existing Internal Communications 20
Modify Profile Settings 21
Field Level Security 21
HR Manager Portal Tabs for WX 22
Policy Options for Fairsail WX 23
How to Set Up and Use WX Services 24
Creating a New WX Service 25
Creating a New WX Process 27
How to Ensure Service and Process Names can be Translated 31
Maintaining Translations in WX 35
Translation Workbench: WX Process 36
Translation Workbench: WX Service 36
How to Use HR Noticeboard with WX 37
Adding WX Fields to HR Noticeboard Page Layout 38
Adding the HR Noticeboard Related List 40
Adding HR Notices to WX Pages 41
Fairsail WX Configuration Guide
© Fairsail 2017
3
Contents
How to Set Up and Use Internal Communications 43
Policy Options: Internal Communications 44
Creating a New Internal Communication 45
Adding Local Language Versions 49
Creating a New Internal Communication from a WX Process 52
Using Scoring for WX Internal Communications 55
Using Confirmation for WX Internal Communications 58
Embedding Social Feeds in WX 59
Picklists: Internal Communication 60
Translation Workbench: Internal Communication 61
How to Set Up Recognition 63
Policy Options: Recognition 64
Translation Workbench: Recognition 65
Field Sets: Recognition 65
How to Set Up a Summary Process 66
Policy Options: Summary 68
Translation Workbench: Summary Process 68
How to Set Up Year End Vacation Balance Reporting 69
Setting up a Batch to Update Report Data 71
Running a Batch Immediately 72
Policy Options: Async Reporting 73
Enabling Data Display and Configuring Tile Content 74
Translation Workbench: Async Reporting 75
How to Set Up Payslips 78
Policy Options: Payslips 79
Field Sets: Payslips 79
Viewing and Editing Payslip Data through the HR Manager Portal 80
How to Set Up Compensation Planning 82
How to Set Up Delegated Access for Assistants 83
How to Set Up Non-HCM Processes 84
Internal Recruitment 85
Relevant Field Sets 85
Hiring Manager 87
Relevant Field Sets 88
Fairsail WX Configuration Guide
© Fairsail 2017
4
Contents
WX Options on the HCM Configure Page 92
How to Optimize WX Performance 93
Speeding Up WX Initial Page Loading 94
Speeding Up WX After Initial Page Loading 95
Changing the Appearance of Your WX 98
How to Change the Fairsail WX Title 99
How to Change the Fairsail Logo 100
How to Change the Base Color 102
Translation Workbench: Wx Base Colour Setup 103
Guidelines for Team Member Pictures 104
How to Add a Supported Language 105
Checking and Adding Available Languages 106
Adding a Language to Your Org 108
Adding and Amending the Language Selector Picklist 110
Changing the Default Language 111
Locale Codes 112
Glossary of Terms 117
Index 119
Fairsail WX Configuration Guide
© Fairsail 2017
5
About this Guide
This Fairsail WX Configuration Guide provides supporting information for setting up and maintaining the
extra functionality delivered with Fairsail WX. It complements the Fairsail HCM Configuration Guide. Setting
up existing functionality for use through Fairsail WX is unchanged except where indicated in Changes to
Existing Process Configuration (see page 84).
Enhancements in this release are shown:
indicates a completely new feature.
Highlighted text
indicates a significant enhancement.
Screenshots show default settings captured from a standard Fairsail system. Your own implementation may
vary.
Related Guides
Fairsail HCM Configuration Guide
Coverage summary
How to set up, manage, and maintain the Fairsail HCM system. Includes detailed configuration information.
Typical target audience
You have overall responsibility for the content of the Fairsail system within your organization and provide
first line support for HR Managers.
Fairsail HCM: Guide for HR Managers
Coverage summary
How to use the Fairsail HR Manager's Portal to enter and maintain employment details, including salary,
salary related, and benefits information. How to use reports and dashboards to extract and view
information held in the Fairsail system.
Typical target audience
You have responsibility for the HR records of a number of employees and provide first line support on the
HR system for them.
Fairsail WX Configuration Guide
© Fairsail 2017
6
About this Guide
Feedback
Fairsail WX: Guide for Users
Coverage summary
How to use Fairsail WX for all day to day HR processes, such as booking vacation and recording absence,
setting and checking objectives, and recording changes to your personal circumstances.
Typical target audience
You are an employee with no special HR duties, though you may run a team and have operational
responsibility for them. You want quick and easy self service access to the information your organization
asks you to maintain about yourself and your direct reports.
Fairsail Analytics: WX Reports
Coverage summary
How to set up and use the extended reporting features delivered with WX Reports. Includes configuration
information and guidelines for getting the most out of WX Reports, as well as end user display guidance.
Typical target audience
You have access to, and some familiarity with underlying Salesforce reporting functionality, and may be
asked to configure reports for delivery to specific groups of users within your organization.
Moving from Fairsail Collaboration Portal to WX
Coverage summary
A largely visual guide to making the move from using the Fairsail Collaboration Portal to Fairsail WX. From
initial orientation through display and editing, the guide covers the essentials, and the essential differences
between the two ways of using your Fairsail system.
Typical target audience
You are an employee with no special HR duties, though you may run a team and have operational
responsibility for them. You have been using Fairsail Collaboration Portal and want to move to Fairsail WX.
Feedback
Feedback from you on our products and on our documentation is important to us. We seek to incorporate
your ideas in future enhancements to our products, and only by understanding your requirements can we
hope to meet or exceed your expectations.
• To provide comments and suggestions on any aspect of Fairsail please email us:
[email protected]
• To provide specific feedback on our documentation please email our documentation team:
[email protected]
Thank you!
Fairsail WX Configuration Guide
© Fairsail 2017
7
Introduction
Key features of Fairsail WX are:
• WX Service
The top level grouping comprising one or more WX Processes. For example, a Performance
Management Service with component Processes for Objectives, Recognition, and Performance Review.
You have complete flexibility when naming WX Services - choose names and groupings of Processes that
make sense within your organization (see page 24).
WX Services are displayed to Team Members through the WX Navigation Bar and Service Bar.
Fairsail WX Configuration Guide
© Fairsail 2017
8
Introduction
Feedback
• WX Process
Individual processes mapping to specific Fairsail processes and grouped into WX Services. As with WX
Services, you can name a WX Process to suit the requirements of your organization. Each WX Process
has a summary Tile view, and most also have a Detail view.
You can include the same Process in one or more WX Services, making a Process easier to find. For
example, include a Skills Process in:
o
A Skills & Competencies Service
o
A Performance Management Service
o
A Career Planning Service
WX Processes are displayed nested within WX Services in the Navigation Bar and Service Bar, with
summaries displayed in Tiles and Detail in the main page view.
• Internal Communication
A powerful and adaptable type of WX Process, enabling you to create broadcast, or more tightly
targeted communications in a range of formats including:
o
Rich Text.
o
External website, providing easy access to external resources and feeds from third party systems,
subject to your organization's security policies.
o
Video, useful for high impact messaging.
Build a library of Internal Communications and assign them to WX Services as you would any other WX
Process (see page 43).
Create local language versions of Internal Communications and associate each with a locale setting;
Team Members with matching locale settings then see the localized version of the Internal
Communication (see page 49).
Use Internal Communications for surveys seeking feedback, storing responses for analysis (see page 55).
• Recognition
A WX Process type enabling your Team Members to award visible and immediate positive feedback to
others. Typically aligned with core competencies or values defined for your organization, Recognition
integrates social performance management with the rest of the Fairsail system (see page 63).
• Summary
High level WX reporting processes, initially available to display:
o
A total employees counter
o
Birthdays in the next 7 days
o
New hires in the last 7 days.
You can display birthday greeting or welcome messages in WX for those Team Members with birthdays
today or who are new hires (see page 66).
• Year End Vacation Balance Reporting
A WX Process type enabling you to present a configurable report on team vacation absence balances
(see page 69).
Fairsail WX Configuration Guide
© Fairsail 2017
9
Introduction
Feedback
• WX Reports
A WX Process type delivering a set of standard Salesforce reporting features through an enhanced
charting interface. WX Reports can be made available to managers and Team Members. Implementation
and use is covered in the separate Fairsail Analytics: WX Reports guide.
Configuring WX features follows standard Fairsail practice; you need access to the Administration settings
available through the HR Manager Portal where you can find new tabs for WX Services, Internal
Communications, and WX Reports.
If you are upgrading an existing HCM org to the latest WX release, you may have to change some
configuration settings (see page 16).
Fairsail WX Configuration Guide
© Fairsail 2017
10
Introduction
Fairsail Processes in this WX Release
Fairsail Processes in this WX Release
This release of Fairsail WX delivers the following processes, listed in alphabetical order:
Absence
A combined process covering all forms of voluntary and involuntary absence from
work. Graphical calendar date selection and display, with clear identification of
absence, past, requested, and confirmed, in a single view.
Actions
Outstanding actions you need to do, categorized by Service. Includes links to
complete each action, with bulk selection for multiple actions. Badging against each
Service and Process in the Navigation Bar shows where actions are due.
Async Reporting
Generate and view a regular report on vacation absence balances for your team.
Presents managers with a single page view of current and forecast predictable
absence for their direct reports.
Auto Enrolment
Information and options specific to the United Kingdom's legally required and
regulated workplace pension programme.
Benefits
Access to your employment benefits and the benefit enrollment process.
Bonus Planning
Access for managers to bonus award planning for their teams. Bonus Planning and
Salary Planning together comprise Compensation Planning.
Competency Assessment
Assess Team Members against a list of competencies and behaviors. From simple
manager assessment, through manager, Team Member, and peers to full 360
assessment including input from external assessors.
Dependants
Names, relationships, and other details for your dependants.
In WX, you can create separate Dependants processes; they do not have to be part of
the Personal Profile.
Development Needs
Manager and Team Member can identify and track skills and competencies that need
to be developed, and objectives defined as a single item that need to be achieved.
Record required skill levels, action plans, and target dates.
Education History
Your academic achievements with places, dates, qualifications and awards.
Emergency Contacts
Names, contact details, and priority to call information for your emergency contacts.
In WX, you can create separate Emergency Contacts processes; they do not have to
be part of the Personal Profile.
Employment Details
Summary employment information about your Team Members, typically used for
salary and salary related information.
Forms
Access to e-forms for completion, submission, approval, and viewing.
Hiring Manager
View and edit vacancies in your organization for which you are the Hiring Manager.
Requires Fairsail Recruit and Fairsail Resource Manager.
HR Noticeboard
Text and image messages at the top and bottom of WX Service and WX Process
views. HR Noticeboard is set up by your HR Manager or Administrator.
HR Requests
Request changes to employment details for your direct reports.
Fairsail WX Configuration Guide
© Fairsail 2017
11
Introduction
Fairsail Processes in this WX Release
Internal Communications
A vehicle for providing a huge range of information direct to the Team Members who
need to see it, when they need it. Information can be supplied as rich text, video, or
website and effectively embedded in Fairsail WX. Internal Communications can
include requests for feedback. enabling simple acknowledgement, voting or scoring.
Internal Communications are set up and used by your HR Manager or Administrator;
as a Team Member all you have to do is consume the information.
Internal Portal
Access to your organization's internal vacancies, with links to enable you to apply or
nominate someone else. Requires Fairsail Recruit and Fairsail Resource Manager.
Job Description
Record the roles and responsibilities of a job. Draw on your organization's established
library of approved job descriptions, or create a new one by copying and editing or by
creating from scratch.
Manager Notes
Record brief information related to a specific Service or Process for a Team Member.
Typically used as an informal record of some interaction between a Manager and a
Team Member, Notes can be used to contribute to any of the more formal review
processes, and to add information relevant to any other process.
The level of confidentiality is configurable, and Manager Notes can be set up to
enable Team Members to add notes to their own profiles.
Metrics Review
Rate employee performance using the requirements of a Job Profile against a
number or a scale such as frequency, expertise, or agreement. You can also record a
simple text assessment. Conduct and view the review through WX.
My Applications
View the status of internal vacancies for which you have applied. Requires Fairsail
Recruit and Fairsail Resource Manager.
Objectives
Collaborative manager-team member objective development, recording and review,
with options for contributory milestones. Linked to Actions for prompting and timely
review
Organization Chart
Graphically displayed organizational information with Team Member pictures, job
titles and contact information. Drill down to teams and link to individual profiles.
Print your org chart for offline use.
Passports
Information about your current passport and associated visas.
Payslips
View pay details extracted from payroll runs.
Performance Review
Collaborative, periodic review of team member performance. Linked to Actions.
Personal Details
Essential information about you such as your full name, residential address, home
contact details, and other information required by your organization.
In WX, you can create separate Personal Details processes; they do not have to be
part of the Personal Profile.
Recognition
Social performance management, giving all Team Members the ability to give positive
and visible feedback to others.
Reporting
Tabular and graphical reporting for managers and team members in WX. Each report
starts life as an underlying Salesforce report with full access to Fairsail data.
Administrators can change field content and data filtering before reports are
displayed to targeted groups of employees.
Salary Planning
Access for managers to salary award planning for their teams. Salary Planning and
Bonus Planning together comprise Compensation Planning.
Skills
Record skills with your current level of expertise, drill down to detail and to see
others in your organization with the same skills.
Fairsail WX Configuration Guide
© Fairsail 2017
12
Introduction
Fairsail Processes in this WX Release
Stock Options
Display the stock option component of employee compensation and benefits. Enable
employees to view options granted, vested and exercised in graphical and tabular
form.
Succession Plan
Enables managers to designate successors for key Team Members, along with
readiness ratings.
Summary
A configurable, high level reporting process, initially with three options:
• Display total number of employees.
• Display birthdays in your organization in the next 7 days.
• Display new hires in your organization in the last 7 days.
Talent Plan
Assess current Team Member performance against potential, and risk of leaving
against the business impact of loss. Represents the results on an overall 9-box grid or
organization chart layout for your team.
Targets
Set financial targets or quotas for Team Members, monitor actuals in the active
period, and record comments on the level of success achieved.
Timesheets
Record your time at work by date and duration, with setup options that enable
recording by total time, start-end time, pay code, or work allocation - project,
customer, or some other measure.
Training
Identify, record, request or assign, and track your development related training
needs.
Work Details
Information about your role in the organization, typically including your function,
division, contact details, and so on.
Work History/Experience
Information about your previous employments, with locations, job titles, manager
names, dates, and brief descriptions.
Fairsail WX Configuration Guide
© Fairsail 2017
13
Introduction
Browser Compatibility
Browser Compatibility
Fairsail WX supports the following browsers:
• Apple Safari version 5 or later
• Google Chrome
• Microsoft Internet Explorer version 10 or later
o
Salesforce applies some limitations to support for Internet Explorer. Refer to Salesforce help topics
for Supported Browsers for more information.
• Mozilla Firefox version 4 or later
• Opera version 11 or later
Fairsail tests all software releases against the latest commercially available and stable versions of all listed
browsers, as well as a range of earlier versions including those known to be used by our customers. Where
testing reveals non-critical anomalies in feature support that cannot be resolved before release, we add a
note describing the issue next to the description of the feature.
To optimize security and ensure the best possible level of technical support from your browser supplier,
always run the latest available, fully supported version.
Fairsail WX Configuration Guide
© Fairsail 2017
14
Introduction
Moving End Users From Collaboration Portal To WX
Moving End Users From Collaboration Portal To WX
If your organization uses some or all of the available processes (see page 11) and no others, you can switch
all your users from the Collaboration Portal to WX as soon as you are ready. If you use Fairsail processes
that are not yet available in WX you can:
• Delay switching from the Collaboration Portal to WX until all the processes you use are available.
• Divide your users into groups and allocate those groups to different Policies. Because WX is enabled
through Policy settings, you can then choose which groups of users you want to migrate, and when.
Fairsail WX Configuration Guide
© Fairsail 2017
15
Upgrading to the Latest WX Release
If you are upgrading an existing Fairsail HCM org to the latest version of Fairsail WX, check the following
settings and change as described if necessary.
Do you have...
Go to..
Fairsail HCM with one or more existing WX Services?
Modify Page Layout: Existing WX Services (see page
17)
Fairsail HCM with no existing WX Services?
Modify Page Layout: No Existing WX Services (see
page 19)
Fairsail HCM with one or more Internal
Communications?
Modify Existing Internal Communications (see page
Profile settings correctly configured?
Modify Profile Settings (see page 21)
Fairsail WX Configuration Guide
20)
© Fairsail 2017
16
Upgrading to the Latest WX Release
Modify Page Layout: Existing WX Services
Modify Page Layout: Existing WX Services
If you have one or more existing WX Services, go to the WX Services Home page and select any WX Service
to display the WX Service Detail page. In the WX Processes Related List, look at the New... button:
If the button is New Internal Communication, change it to New WX Process as follows:
1. In the links at the top right of the page, select Edit Layout.
Fairsail displays the Page Layout for the WX Service Detail page.
2. Scroll down to the Related Lists.
3. For the WX Processes Related List, select Properties
4. In the Properties dialog, expand the Buttons section.
5. Move New Internal Communications from Selected Buttons to Available Buttons.
6. Move New WX Process from Available Buttons to Selected Buttons.
7. Select OK to close the Properties dialog.
Fairsail WX Configuration Guide
© Fairsail 2017
17
Upgrading to the Latest WX Release
Modify Page Layout: Existing WX Services
8. Select Save to save your changes to the Page Layout.
Now display or refresh a WX Service Detail page and ensure that the WX Processes Related List displays the
New WX Process button:
Fairsail WX Configuration Guide
© Fairsail 2017
18
Upgrading to the Latest WX Release
Modify Page Layout: No Existing WX Services
Modify Page Layout: No Existing WX Services
1. Go to Setup > App Setup > Create > Objects
2. In the list of Custom Objects, scroll down to WX Service and select the Label.
Fairsail displays the Custom Object Definition Detail page for WX Service.
3. Go to the Page Layouts section and select Edit.
Fairsail displays the Page Layout for the WX Service Detail page.
4. Scroll down to the Related Lists.
5. For the WX Processes Related List, select Properties
6. In the Properties dialog, expand the Buttons section.
7. Move New Internal Communications from Selected Buttons to Available Buttons.
8. Move New WX Process from Available Buttons to Selected Buttons.
9. Select OK to close the Properties dialog.
10.Select Save to save your changes to the Page Layout.
Fairsail WX Configuration Guide
© Fairsail 2017
19
Upgrading to the Latest WX Release
Modify Existing Internal Communications
Modify Existing Internal Communications
If you have one or more existing Internal Communications, make sure they are set to Show to Team
Member:
1. Select the Internal Communications tab.
2. Select an Internal Communication.
Fairsail displays the Internal Communication Detail page.
3. Select Edit.
Fairsail displays the Internal Communication page.
4. Select the Advanced Options tab.
5. Make sure the Show to Team Member checkbox is checked:
6. Select Save.
7. Repeat for all existing Internal Communications.
Fairsail WX Configuration Guide
© Fairsail 2017
20
Upgrading to the Latest WX Release
Modify Profile Settings
Modify Profile Settings
All Profiles need access to the following Visualforce pages:
• fHCM2.CollaborationPortalCSS
• fHCM2.CollaborationPortalIndex
• fHCM2.CustomLabelTranslations
In addition, Team Member Profiles need the following Custom Object permissions:
Object
Permission
Read
Create
Edit
Delete
View All
Modify All
Internal Communications
Internal Communication Instances
Internal Communication Languages
Internal Communication Score
Results
Profiles control access to data - they are one of the mechanisms used by Fairsail to help ensure the
security of your data. If you need guidance on modifying Profiles, contact Fairsail.
Field Level Security
Do not modify field-level security settings for any aspect of Fairsail WX.
Changing field-level security settings can cause conflicts between the HCM security model and the
security model supported by Salesforce.
Fairsail WX Configuration Guide
© Fairsail 2017
21
HR Manager Portal Tabs for WX
Tab
Displays
WX Services
The Fairsail WX Services available in your organization.
WX Services host the WX Processes used by your Team Members, and can be named
to suit the needs of your organization (see page 24).
Internal Communications
The Internal Communications available in your organization.
Internal Communications are WX Processes delivered in text, video, or website form.
Each Internal Communication can be associated with one or more WX Services and
have localized versions for locale-specific display throughout your organization.
WX Reports
The reoprts set up for managers and team members to view through WX.
WX Reports are based on underlying Salesforce reports with field content and data
filtering configured to meet your requirements. WX Reports can be displayed in
tabular or graphical form
Roles
Roles defined to execute actions on behalf of someone else. Roles enable you to map
one or more people to act as delegates for one or more others.
Fairsail WX Configuration Guide
© Fairsail 2017
22
Policy Options for Fairsail WX
Option
Description
WX is Active
Checkbox. If checked, WX is active and replaces Collaboration Portal for all
Team Members allocated to this Policy.
WX Title
Text. The name you want to display in the title bar for the version of WX
controlled by this Policy.
WX Colour
A hexadecimal color code, preceded by hash (#), for example:
#BF3DA1
The color used as the base to drive the range of tints used for the version of
WX controlled by this Policy. Overrides the generic base color defined in the
HCM Configure page (see page 102).
WX Logo
The Static Resource name of the logo file used for the version of WX
controlled by this Policy. The logo replaces the default Fairsail logo displayed
in the title bar.
There are also Policy options for:
• Internal Communications (see page 44).
• Payslips (see page 79).
• Recognition (see page 64).
• Async Reporting (see page 73).
• Summary (see page 68).
• Reporting (see the separate Fairsail Analytics:
WX Reports guide).
Fairsail WX Configuration Guide
© Fairsail 2017
23
How to Set Up and Use WX Services
Fairsail WX Configuration Guide
© Fairsail 2017
24
How to Set Up and Use WX Services
Creating a New WX Service
Creating a New WX Service
You can create as many WX Services as you need for your organization, with each Service containing all
necessary Processes. Usability - particularly on devices with smaller screens - is likely to put a practical limit
on the number of Services and Processes you want to display.
1. Select the WX Services tab.
2. On the WX Services Home page, select New.
Fairsail displays the New WX Service Edit page:
3. Complete the fields as follows:
WX Service Name
The name you want to display in WX for this service.
Use a name that summarizes the processes you are planning to group within it - Team
Members use the Service names to navigate WX and effective naming helps them find
what they're looking for as quickly as possible.
Order
Number, no decimal places. The order in which you want this service displayed in the
Navigation Bar and the Service Bar. Lower numbered Services are displayed above higher
numbered in the Navigation Bar, and to the left of higher numbered in the Service Bar.
Use numbers that make it easy to change the order and add new Services, for example
use 10, 20, 30 rather than 1, 2, 3.
4. Select:
o
Save to save the Service and display the WX Service Detail page.
o
Save & New to save this Service and create another.
o
Cancel to discard this Service without saving and return to the WX Services Home page.
Fairsail WX Configuration Guide
© Fairsail 2017
25
How to Set Up and Use WX Services
Creating a New WX Service
The WX Service Detail page for a newly created Service looks like this:
You are now ready to add Processes to the Service - a Service with no Processes is not displayed in WX.
Fairsail WX Configuration Guide
© Fairsail 2017
26
How to Set Up and Use WX Services
Creating a New WX Process
Creating a New WX Process
1. Select the WX Services tab.
2. On the WX Services Home page, select a View that shows the Service to which you want to add a
Process, and select the WX Service Name.
Fairsail displays the WX Service Detail page:
3. In the WX Processes related list, select New WX Process.
Fairsail displays the WX Process page:
Fairsail WX Configuration Guide
© Fairsail 2017
27
How to Set Up and Use WX Services
Creating a New WX Process
4. Complete the fields as follows:
Field
Description
Label
The name you want to use for this Process. The label is displayed:
• In the Navigation Bar.
• On the Tile for the Process.
• On the Detail page for the Process.
Use a Label that will be easily recognized by Team Members. Labels do not have to
correspond to the generic Fairsail WX Process Type - choose a name that is meaningful
for your organization.
Active
Checkbox. If checked, this Process is active and can be displayed and used in WX.
Checked by default.
WX Service
The name of the Service you want to host this Process. By default, Fairsail inserts the
name of the Service you selected at the start of this procedure.
To go to the WX Service Detail page, select the Service name.
To Edit the Service Name or Order, hover over the Service Name and select Edit in the
popup:
Order
Number, no decimal places. The order in which you want this Process displayed within
the Service.
Lower numbered Processes are displayed above higher numbered in the Navigation Bar.
Process Tiles are displayed left to right, low number to high, and then in rows from top
to bottom:
Use numbers that make it easy to change the order and add new Processes, for example
use 10, 20, 30 rather than 1, 2, 3.
Start Date
The date from which you want the Process to be available.
Leave blank if you want the Process to be available immediately.
End Date
The date after which you no longer want the Process to be available.
Leave blank if you want the Process to be available indefinitely.
Fairsail WX Configuration Guide
© Fairsail 2017
28
How to Set Up and Use WX Services
Creating a New WX Process
Field
Description
Preferred Number Of
Columns
Number, no decimal places. The number of columns you want Fairsail to use when
displaying the tile for this Process with other Processes in the same Service.
Currently supports 1 or 2.
Indicative for desktop screen sizes; the actual number of columns reduces responsively
for smaller screens. On mobiles, tiles are displayed in a single column regardless of the
value in this field. When calculating actual number of columns WX optimizes the display,
taking into account:
• Preferred Number Of Columns
• Available space
• Form factor
WX Process Type
Picklist. The Fairsail Process you want to use. The picklist contains all the Fairsail
processes available to you, for example:
• Performance Review
• Objectives
• Absences
• Internal Communications
• Recognition
Select the picklist and select the WX Process Type you want to use.
WX Internal
Communication
Displayed when you select the Internal Communications Process Type.
If you have an existing Internal Communication you want to use for this Process, select
WX Internal Communication Lookup
, find and select it.
If you want to create a new Internal Communication now, select New to display the WX
Internal Communications fields at the bottom of the page (see page 52).
Show In Mobile
Checkbox. If checked, this Process instance is displayed by the Fairsail Mobile app.
Unchecked by default.
While all WX Processes can be displayed by Mobile, those with fewer options and less
complex displays work best.
Show In Mobile does not affect the availability of processes through a browser on a
mobile device; it is used solely to switch a process on or off in the Fairsail Mobile app.
Show Title In Tile
Checkbox. If checked, the Label is displayed at the top of the Process Tile.
Show Title In Detail
Checkbox. If checked, the Label is displayed at the top of the Detail page.
If unchecked, the Detail page displays the default Custom Label associated with the
Process, for example, Current Objectives, Skills, Targets.
Additional
Information
Text. For many processes you can enter filter information as one or more key-value pairs
to control the display of data for each instance of that process. Each key-value pair
contains a unique identifier - the key - and a data value for that item.
For example, for a New Hires Summary Process, Additional Information can contain two
key-value pairs, one to specify the content type and one to specify a message:
contentType=new hires
messageToSelf=Welcome!
Permitted content is given in the configuration information for each Process.
Fairsail WX Configuration Guide
© Fairsail 2017
29
How to Set Up and Use WX Services
Creating a New WX Process
Field
Description
Hide When Read
Checkbox. Displayed when you select the Internal Communications Process Type.
If checked, the Internal Communication is hidden when the Team Member confirms that
they have read it.
If checked, Confirm When Read must also be checked.
Confirm When Read
Checkbox. Displayed when you select the Internal Communications Process Type.
If checked, a message is displayed with the Internal Communication asking the Team
Member to confirm they have read it.
Score has Action
Checkbox. Displayed when you select the Internal Communications Process Type.
If checked, an Action is raised for Team Members receiving the Internal Communication,
prompting them to respond.
5. Select Save.
Fairsail displays the WX Process page. The Process is added to the WX Service and displayed in the
Navigation Bar next time you open or refresh WX.
Fairsail WX Configuration Guide
© Fairsail 2017
30
How to Set Up and Use WX Services
How to Ensure Service and Process Names can be Translated
How to Ensure Service and Process Names can be Translated
When creating WX Services and Processes you must specify a Name for each Service and a Label for each
Process. The default procedure is to enter these as text strings; they are then displayed exactly as entered
regardless of the language setting chosen for WX.
To ensure that WX Service Names and Process Labels can be translated into local languages:
• Create a Custom Label for each Service Name and Process Label you want to display in local languages.
• Use the Custom Labels to host the translations you want to display.
• Create a text file to hold the Custom Label names. Maintain the text file if you add more custom labels
and translations.
• Load the text file as a Static Resource for WX to use.
• Create an Apex Class and add code to enable WX to access the static resource. This is a once-only
operation for each org.
• Ensure that the languages you want to use are activated in the Translation Workbench.
Follow these steps:
1. Go to Setup > App Setup > Create > Custom Labels and select New Custom Label.
Create a new Custom Label for each WX Service Name and Process Label you want to display in local
languages.
2. Complete the fields as follows:
Short Description
A brief description of the label. By default, Name is created from the Short Description
and the two are typically left with the same text content. If you are using default Name
creation to create the Name directly from the Short Description, start Short Description
with WX_ (that is, WX immediately followed by an underscore) to ensure WX hides the
label name for the short interval while translations are loaded.
If Name is not self explanatory, use Short Description to help define the purpose of the
label.
Categories
Optional. Enter one or more text categories for this label separated by commas. You can
use Categories to sort and filter labels.
Value
The default text string to display when this label is selected. If you do not load
translations for this label, Value is always displayed when the label is selected.
Name
The API key for this label. Automatically created from the Short Description, you can
change the Name if you wish.
To ensure WX hides the label name for the short interval while translations are loaded,
start Name with the characters WX_
Must begin with a letter and contain only alphanumeric characters and underscores.
Cannot end with an underscore or contain two consecutive underscores.
Protected Component Checkbox. Set unchecked.
3. Select Save.
Fairsail displays the Custom Label Detail page.
Fairsail WX Configuration Guide
© Fairsail 2017
31
How to Set Up and Use WX Services
How to Ensure Service and Process Names can be Translated
4. In the Translations Related List, select New.
Fairsail displays the New Translation page.
5. In the Translation Information section:
o
Select the Language you want to add for this Custom Label.
o
Enter the Translation Text you want to appear when the Language is selected to display this label.
6. Select Save.
Fairsail displays the Translation Detail page. To add another translation, select the Master Label:
Repeat steps 5 and 6 to add as many translations as you need. You can add a value for the default
language (typically English) if you do not want the WX Service Name or Process Label to display the
default Value for the Custom Label when the default language is displayed.
7. In the WX Service or Process that will use the translations you have loaded, enter the Custom Label
Name exactly as specified for the Custom Label.
8. Use a text editor to create a plain text file holding all the Master Label Names, one per line. Make sure
that each Name is exactly as specified on the Custom Label Detail page; this is the key used by WX to
map the translations for display.
Use a single text file for all the Custom Labels you are creating for translatable WX Service Names and
Process Labels.
9. Save the file with a meaningful name, for example:
MyCompanyName_WX_Labels.txt
10.Go to Setup > App Setup > Develop > Static Resources
11.Select New.
Fairsail displays the Static Resource Edit page.
12.Complete the fields as follows:
Name
A name for the Static Resource. Choose a name that helps you identify the file easily,
such as:
Custom_Label_Translation_Keys.
You cannot use spaces in the Name field.
Description
Optional. A brief description of the purpose of the Static Resource, such as:
Text file with Custom Label API keys for WX Service and Process name translations.
File
Select Choose File, find and select the text file you created earlier.
Cache Control
Picklist. Select Private.
13. Select Save.
Fairsail adds the new Static Resource to those available to your org.
Fairsail WX Configuration Guide
© Fairsail 2017
32
How to Set Up and Use WX Services
How to Ensure Service and Process Names can be Translated
14.Go to Setup > App Setup > Develop > Apex Classes
15.Select New.
You need to create two Apex Classes:
• One to identify the Static Resource holding the translation keys
• One test class
You can create new Apex Classes in Sandbox and Development orgs, not in Production orgs. To insert the Apex
Classes in a Production org, you would typically create them in the associated Sandbox and then deploy to the
Production org. Create the Apex Classes and then follow the instructions given below, following creation of the
Apex Classes.
Fairsail displays the Apex Class Edit page.
16.On the Apex Class tab, copy and paste this text:
global class ApexClassName implements fHCM2.WXPackage {
global List<String> getTranslationKeys() {
String staticResourceName = 'Custom_Label_Translation_Keys';
List<String> labelNames = new List<String>();
try {
StaticResource sr = [SELECT body, name, NamespacePrefix FROM StaticRe
source WHERE Name =: staticResourceName LIMIT 1];
fHCM2.TranslationHelper.addLabels(labelNames, sr);
} catch (Exception ex) {
System.debug('Failed to get translations for '+ staticResourceName +'
: ' + ex);
}
return labelNames;
}
}
Where:
o ApexClassName
is a meaningful name for the Apex Class of up to 40 characters, with no spaces. For example:
MyCompanyName_WXPackage
o Custom_Label_Translation_Keys
is the name of the static resource you created.
17. Select Save.
Fairsail displays the Apex Class Detail page for the new Apex Class.
Fairsail WX Configuration Guide
© Fairsail 2017
33
How to Set Up and Use WX Services
How to Ensure Service and Process Names can be Translated
18.Repeat to create a test class, entering the following code on the Apex Class tab:
public class ApexTestClass {
@isTest public static void testTranslations() {
ApexClassName p = new ApexClassName();
System.assert(p.getTranslationKeys().size() > 0);
}
}
Where:
o ApexTestClass
is a meaningful name for the test class of up to 40 characters, with no spaces. For example:
MyCompanyName_WXPackageTest
o ApexClassName
is the name of the Apex Class you used for the main Apex Class you created in the previous step.
19.Select Save.
Fairsail displays the Apex Class Detail page for the new Apex Test Class.
You typically complete the procedure and test that translations are working in the Sandbox before deploying to
Production.
The Production org must have the Sandbox defined as a Connected org to enable it to receive the Change Set
containing the Apex Class.
When you are ready to deploy the Apex Classes into a Production org, in the associated Sandbox:
a. Go to Setup > App Setup > Deploy > Outbound Change Sets
b. If a splash page is displayed, select Continue
c. On the Outbound Change Sets page, in the Change Sets list, select New
Fairsail displays the New Change Set page.
d. Enter a Name for the change set, for example WXPackage Apex Class, and an optional Description.
e. Select Save.
Fairsail displays the Change Set page for your new Change Set.
f. In the Change Set Components section, select Add.
g. In Component Type select the picklist and choose Apex Class
h. In the displayed list select the ApexClassName and the ApexTestClass you created earlier.
i. Select Add To Change Set.
Fairsail adds the Apex Classes to the Change Set Components section of the Change Set page.
j. In the Change Set Detail section, select Upload.
k. Select the target Production org and select Upload.
l. When upload completes, login to the Production org.
m. Go to Setup > App Setup > Deploy > Inbound Change Sets
n. If a splash page is displayed, select Continue
o. In the change sets awaiting deployment list, select the Change Set you created earlier.
p. Select Deploy.
Now repeat the following steps in the Production org to register the Apex Class.
Fairsail WX Configuration Guide
© Fairsail 2017
34
How to Set Up and Use WX Services
How to Ensure Service and Process Names can be Translated
20.Open the Developer Console and go to Debug > Open Execute Anonymous Window.
21.In an empty window enter:
fHCM2.WXPackages.Register('ApexClassName', 'org_namespace', true);
fHCM2.WXPackages.SaveRegistered();
Where:
o ApexClassName
is as entered when creating the Apex Class.
o org_namespace
is the namespace of your org. If the org does not have a namespace, enter null with no enclosing
quote marks.
Namespaces can be registered for Developer orgs and not for Production or Sandbox orgs; if you
are working with a Production or Sandbox org, set org_namespace to null.
o true
is:
true
to overwrite existing settings.
false
to add these settings to an existing setup.
22.Select Execute, and close the Developer Console.
23.Go to Setup > Administration Setup > Translation Workbench > Translation Settings
24.Check that all languages you want to use are marked as Active.
To activate a language:
a. in the Action column for the language, select Edit.
b. On the Language Translation Edit page check Active.
c. Select Save.
25.Test that your translations are working by selecting a WX Service or Process that has a translation
loaded and use the Language Selector to select an appropriate language.
When WX loads it now seeks out any existing translations for the WX Service Names and Process Labels for
display.
Maintaining Translations in WX
Once set up as described (see page 31), maintaining translations in a working Production environment
involves:
• Creating Custom Labels for each newly added Service Name and Process Label you want to display in a
local language.
• Commissioning the local language translations.
• Adding the translated terms to the Custom Labels.
• Modifying the text file holding the Custom Label names to include the new labels, and reloading it as the
Static Resource file.
You do not need to recreate, re-register, or modify the Apex Class.
Fairsail WX Configuration Guide
© Fairsail 2017
35
How to Set Up and Use WX Services
Translation Workbench: WX Process
Translation Workbench: WX Process
WX Process Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Active
Checkbox
Additional Information
Long Text Area (32768)
End Date
Date
Label
Text (255)
Order
Number (8,0)
Preferred Number Of Columns
Number (2,0)
Process
Text (128)
Show In Mobile
Checkbox
Show Title In Detail
Checkbox
Show Title In Tile
Checkbox
Start Date
Date
Team Member Or Team
Picklist
WX Service
Lookup (WX Service)
WX Process Confirmation Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Confirmation Date
Date
Is Confirmed
Formula (Checkbox)
Process Instance
Master-Detail (WX Process)
Team Member
Lookup (Team Member)
Translation Workbench: WX Service
WX Service Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Order
Fairsail WX Configuration Guide
Field Type
Number (8,0) (Unique)
© Fairsail 2017
36
How to Use HR Noticeboard with WX
You can use the HR Noticeboard to display notices in the header and footer areas of WX pages:
To use the HR Noticeboard with WX:
1. Add the WX Service, WX Process, and Show to Other fields to the HR Noticeboard page layout (see page
38).
2. Add the HR Noticeboard Related List to the WX Service Page Layout (see page 40).
3. On the HR Notice Edit page:
o
Specify the WX Service or Process to display the notice, and who is able to view it (see page 41).
o
Choose the location you want the notice to appear (see page 41).
Fairsail WX Configuration Guide
© Fairsail 2017
37
How to Use HR Noticeboard with WX
Adding WX Fields to HR Noticeboard Page Layout
Adding WX Fields to HR Noticeboard Page Layout
1. Go to Setup > App Setup > Create > Objects
2. Scroll down to find the HR Notice object and select the Label.
Fairsail displays the Custom Object Detail page.
3. Go to the Page Layout section and select Edit for HR Notice Layout.
4. Select Fields in the left panel of the HR Notice Layout selector.
5. Drag and drop the three fields WX Service, WX Process and Show To Other on to the HR Notice Sample
layout.
Suggested locations:
o
WX Service and WX Process immediately below HR Notice Name.
o
Show To Other below Show To Manager in the Filter notices... section.
Fairsail WX Configuration Guide
© Fairsail 2017
38
How to Use HR Noticeboard with WX
Adding WX Fields to HR Noticeboard Page Layout
6. Select Save.
Next time you display or refresh HR Notice Detail or HR Notice Edit pages, the new fields are included in the
display:
Fairsail WX Configuration Guide
© Fairsail 2017
39
How to Use HR Noticeboard with WX
Adding the HR Noticeboard Related List
Adding the HR Noticeboard Related List
By default, the WX Service Page Layout does not display the HR Noticeboard Related List. The Related List
enables you to add Notices to Services and Processes from the WX Service Detail page.
To add the HR Noticeboard Related List to the WX Service Page Layout:
1. Open any existing WX Service to display the WX Service Detail page.
2. Select Edit Layout.
3. On the page layout select Related Lists from the left panel.
4. Drag and drop the HR Noticeboard Related List into the Related List section of the page.
Suggested location: below the WX Processes Related List.
5. Select Save.
Next time you display or refresh a WX Service Detail page the HR Noticeboard Related List is displayed.
Fairsail WX Configuration Guide
© Fairsail 2017
40
How to Use HR Noticeboard with WX
Adding HR Notices to WX Pages
Adding HR Notices to WX Pages
You can add HR Notices independently to WX Services and WX Processes - there is no link between them
for HR Notices. You can also reuse existing, pre-WX HR Notices in Fairsail WX.
When you have added the WX Service and WX Process fields to the HR Notice page layout (see page 38)
and added the HR Noticeboard Related List to the WX Service Detail page (see page 40):
1. Select the WX Services tab.
o
To add an HR Notice to a specific WX Service, select that Service.
o
To add an HR Notice to a WX Process, select any Service.
Fairsail displays the WX Service Detail page with the HR Noticeboard Related List.
2. On the WX Service Detail page, go to the HR Noticeboard Related List and select New HR Notice.
Fairsail displays the HR Notice Edit page.
3. Complete the fields as you would for any HR Notice (see the Fairsail HCM: Guide for HR Managers for
more information) with these differences for Fairsail WX:
Field
Description
WX Service
The name of the WX Service you want to host the HR Notice. Automatically completed
for you with the name of the Service you selected at the start of this procedure.
To choose a different WX Service, select WX Service Lookup
Service you want.
, find and select the
To add a Notice to a WX Process rather than a WX Service, leave this field blank and
complete WX Process.
• If you specify a WX Service and leave WX Process blank, the Notice is displayed on
the Service page and not on the pages for the underlying Processes.
• If you leave WX Service blank and specify a WX Process, the Notice is displayed on
the Process page and not on the Service page.
WX Process
The WX Process you want to host the HR Notice.
Select WX Process Lookup
, find and select the Process you want.
To add a Notice to a WX Service rather than a WX Process, leave this field blank and
complete WX Service.
• If you specify a WX Process and leave WX Service blank, the Notice is displayed on
the Process page and not on the Service page.
• If you leave WX Process blank and specify a WX Service, the Notice is displayed on
the Service page and not on the Process page.
Fairsail Page
Not used.
Location
Picklist. For WX choose one of:
• Header (see page 37)
• Footer (see page 37)
SubHeader and SubFooter are not used.
Fairsail WX Configuration Guide
© Fairsail 2017
41
How to Use HR Noticeboard with WX
Adding HR Notices to WX Pages
Field
Description
Filter notices that appear section
Show To Other
Checkbox. If checked the notice is visible to anyone who is not the Team Member and
not in the Team Member's management hierarchy when they view the Team Member's
page in WX.
4. Select Save.
Saved HR Notices are:
• Added to the HR Noticeboard Related List for the hosting WX Service.
• Displayed on the WX Service and Process pages you have chosen, subject to any filters you have
specified on the HR Notice Edit page.
Fairsail WX Configuration Guide
© Fairsail 2017
42
How to Set Up and Use Internal
Communications
The Internal Communications process enables you to create and display a very wide range of
communications including:
• Rich text notices
• Videos
• External websites, including links to social feeds (see page 59)
• Html (available to System Administrators only)
Internal Communications can be:
• Broadcast to all employees.
• Targeted at those assigned to a Policy or Policy Group.
• Visible to a defined group of Team Members.
• Localized with versions for all the locales you need to support.
Actions generated by Internal Communications are added to the Actions Digest and appear in the list of
Actions for all Team Members who need to take action as a result of the communication.
Each Internal Communication must be assigned to one or more WX services - you can create:
• A dedicated service to carry all Internal Communication.
• Internal Communications for specific services, for example:
o
A supporting video for upcoming performance reviews, targeted at managers, and assigned to a
Performance Management service.
o
A bulleted list for best practice skill logging for a Skills & Competencies service.
There are three steps to setting up and using Internal Communications:
1. Switch Internal Communications on in the Policy or Policies you want to use (see page 44).
2. Create the Internal Communication, complete with any localized versions you need (see page 45).
3. Assign the Internal Communication to a WX Service so that it can be displayed on WX (see page 27),
selecting Internal Communications as the WX Process Type, and specifying the Internal Communication
you want to assign.
Fairsail WX Configuration Guide
© Fairsail 2017
43
How to Set Up and Use Internal Communications
Policy Options: Internal Communications
Policy Options: Internal Communications
Option
Description
Internal Communications
Checkbox. If checked, the Internal Communications process is active and
Internal Communications can be displayed through WX.
Fairsail WX Configuration Guide
© Fairsail 2017
44
How to Set Up and Use Internal Communications
Creating a New Internal Communication
Creating a New Internal Communication
1. Select the Internal Communications tab.
Fairsail displays the Internal Communications Home page.
2. Select New.
Fairsail displays the Internal Communication page:
You can complete:
o
Just the Basic Options and save - the Internal Communication is displayed by default to everyone
who has access to the hosting WX Service.
o
The Basic Options and the Advanced Options to define a more restricted target audience.
Fairsail WX Configuration Guide
© Fairsail 2017
45
How to Set Up and Use Internal Communications
Creating a New Internal Communication
3. Complete the fields as follows:
Field
Description
Basic Options tab
Define the content
Internal
Communication
Name
The name you want to use for this Internal Communication. Used for searches. Not
displayed to end users through WX.
Tile Type
The type of Tile you want to create for this Internal Communication. Select the picklist
and choose from:
• Rich Text
• External Website
• Video
• HTML
Tile Content
Displayed if you select Rich Text as the Tile Type.
A text input field with standard formatting buttons:
Enter the summary text you want to appear on the Tile. You can also embed links and
pictures:
The optimum size for pictures depends on the size of the Tile, and that varies in response
to the size of the browser window. As a starting point for desktop display of a single
column Tile, try a picture size of 250px high by 250px wide. The Firefox browser enables
you to resize images in the Internal Communications Detail Edit view; most other
browsers require you to edit the source image file in an image editor and reload it.
External Website Url
Displayed if you select External Website as the Tile Type.
Enter the full url of the website you want to display in the Tile in the form:
https://www.example.com
The website must use the Hypertext Transfer Protocol Secure (https) communication
protocol. Website urls are subject to your organization's access policy - make sure that
your intended target audience is authorized to access the site you want to use.
Video Url
Displayed if you select Video as the Tile Type.
Enter the full url of the video you want to display in the Tile in the form:
https://www.youtube.com/watch...
The video must use the Hypertext Transfer Protocol Secure (https) communication
protocol. Video urls are subject to your organization's access policy - make sure that your
intended target audience is authorized to access the video you want to use.
HTML
Displayed if you select HTML as the Tile Type.
Enter the html you want to be rendered in the Tile.
Fairsail WX Configuration Guide
© Fairsail 2017
46
How to Set Up and Use Internal Communications
Creating a New Internal Communication
Field
Description
Detail Type
The type of Detail you want to create for this Internal Communication. Detail content is
displayed when users select the summary information displayed in the Tile.
Select the picklist and choose from:
• Rich Text
• External Website
• Video
• HTML
If your Tile contains the full message and you do not want to display a Detail panel, leave
Detail Type at its default value and leave the content fields empty.
Detail Content
Displayed if you select Rich Text as the Detail Type.
A text input field with standard formatting buttons:
Enter the
pictures:
External Website Url
text you want to appear in the Detail. You can also
embed links and
Displayed if you select External Website as the Detail Type.
Enter the full url of the website you want to display in the Detail in the form:
https://www.example.com
The website must use the Hypertext Transfer Protocol Secure (https) secure
communication protocol. Website urls are subject to your organization's access policy make sure that your intended target audience is authorized to access the site you want
to use.
Video Url
Displayed if you select Video as the Detail Type.
Enter the full url of the video you want to display in the Detail in the form:
http://www.youtube.com/watch...
The video must use the Hypertext Transfer Protocol Secure (https) secure
communication protocol. Video urls are subject to your organization's access policy make sure that your intended target audience is authorized to access the video you want
to use.
HTML
Displayed if you select HTML as the Detail Type.
Enter the html you want to be rendered in the Tile.
Fairsail WX Configuration Guide
© Fairsail 2017
47
How to Set Up and Use Internal Communications
Creating a New Internal Communication
Field
Description
Advanced Options tab
Define the target if you want to restrict visibility
Policy
The name of the Policy assigned to the Team Members you want to view this Internal
Communication. Select Policy Lookup
, find and select the Policy you want.
Leave blank if you don't want to define the target audience by their Policy.
Policy Group
The name of the Policy Group assigned to the Team Members you want to view this
Internal Communication.
Leave blank if you don't want to define the target audience by their Policy Group.
Show To Manager
Checkbox. If checked, when a Manager views a Team Member's pages, the Internal
Communication is visible to the Team Member's manager, manager's manager, and so
on up the organization hierarchy.
Show To Other
Checkbox. If checked, when someone who is not the Team Member and not a member
of the Team Member's management hierarchy views a Team Member's pages, the
Internal Communication is visible to them.
Show To Team
Member
Checkbox. If checked, the Internal Communication is visible to Team Members viewing
their own WX pages, and not on the team pages when viewed through the manager's
WX.
Team Member
The name of the Team Member you want to receive this Internal Communication. Use in
conjunction with Level Down
Select Team Member Lookup
Level Down
, find and select the Team Member.
The number of levels of the company hierarchy below Team Member you want to show
this Internal Communication.
For example:
• Team Member is the CEO
• Level Down is 1
The Internal Communication is visible to the CEO and C level employees - the CEO's
direct reports.
Scale
The Scale recipients of this Internal Communication use when providing scored
feedback (see page 55).
Required to display a Score button on the Internal Communications Detail view; selecting
Score on the Internal Communication displays the Review Internal Communication view
with a picklist of the Scale values. If used, specify an existing scale in your organization's
Scale Library. Scales typically include those used to measure proficiency, expertise,
frequency, and agreement.
To generate an Action for the Team Member to respond to this Internal Communication,
use the Score Has Action checkbox on the WX Process Instance page.
4. Select Save.
Fairsail displays the Internal Communication Detail page, with Related Lists for:
o
Internal Communication Languages (see page 49)
o
Internal Communication Score Results (see page 55)
Fairsail WX Configuration Guide
© Fairsail 2017
48
How to Set Up and Use Internal Communications
Creating a New Internal Communication
Adding Local Language Versions
You can increase the effectiveness of your organization's Internal Communications by creating local
language versions. Fairsail then displays the version matching the Team Member's locale, defaulting to the
parent version if a locale is not specified or no matching version exists.
To create a local language version of an Internal Communication:
1. On the Internal Communication Detail page, scroll down to the Internal Communication Languages
Related List and select New Internal Communication Language:
Fairsail displays the Internal Communication Language Details page:
This page is a simplified version of the Internal Communication page, Basic Options (see page 45). Local
language versions do not have to use the same Tile and Detail types as the original Internal
Communication - you can tailor these along with the content to meet the needs of each locale.
Fairsail WX Configuration Guide
© Fairsail 2017
49
How to Set Up and Use Internal Communications
Creating a New Internal Communication
2. Complete the fields as follows:
Field
Description
Internal
Communication
The name of the Internal Communication you selected at the start of this procedure.
Automatically completed for you by Fairsail. You can select to view the Internal
Communication Detail page.
Locale
Picklist. Select to display the locale codes (see page 112) for the locales available to you.
Select the locale used by the Team Members you want to view this version of the
Internal Communication. The locale is applied to this version of the Internal
Communication and matched to Team Members with the same locale.
Tile Type
The type of Tile you want to create for this Internal Communication. Select the picklist
and choose from:
• Rich Text
• External Website
• Video
Tile Content
Displayed if you select Rich Text as the Tile Type.
A text input field with standard formatting buttons:
Enter the summary text you want to appear on the Tile. You can also
pictures:
External Website Url
embed links and
Displayed if you select External Website as the Tile Type.
Enter the url of the website you want to display in the Tile in the form:
www.example.com
Website urls are subject to your organization's access policy - make sure that your
intended target audience is authorized to access the site you want to use.
Video Url
Displayed if you select Video as the Tile Type.
Enter the url of the video you want to display in the Tile in the form:
http://www.youtube.com/watch...
Video urls are subject to your organization's access policy - make sure that your intended
target audience is authorized to access the video you want to use.
Detail Type
The type of Detail you want to create for this Internal Communication. Detail content is
displayed when users select the summary information displayed in the Tile.
Select the picklist and choose from:
• Rich Text
• External Website
• Video
If your Tile contains the full message and you do not want to display a Detail panel, leave
Detail Type at its default value and leave the content fields empty.
Fairsail WX Configuration Guide
© Fairsail 2017
50
How to Set Up and Use Internal Communications
Creating a New Internal Communication
Field
Description
Detail Content
Displayed if you select Rich Text as the Detail Type.
A text input field with standard formatting buttons:
Enter the
pictures:
External Website Url
text you want to appear in the Detail. You can also
embed links and
Displayed if you select External Website as the Detail Type.
Enter the url of the website you want to display in the Detail in the form:
www.example.com
Website urls are subject to your organization's access policy - make sure that your
intended target audience is authorized to access the site you want to use.
Video Url
Displayed if you select Video as the Detail Type.
Enter the url of the video you want to display in the Detail in the form:
http://www.youtube.com/watch...
Video urls are subject to your organization's access policy - make sure that your intended
target audience is authorized to access the video you want to use.
3. Select Save.
Fairsail creates the Internal Communication Language, allocates it a unique CNL-nnnn name, and displays
the Internal Communication Language Detail page.
The Internal Communication Language Name is added to the Internal Communication Languages Related
List:
Fairsail WX Configuration Guide
© Fairsail 2017
51
How to Set Up and Use Internal Communications
Creating a New Internal Communication from a WX Process
Creating a New Internal Communication from a WX Process
When creating a WX Process (see page 27), if you choose to create a new WX Internal Communication, the
page displays the WX Internal Communications section:
Fairsail WX Configuration Guide
© Fairsail 2017
52
How to Set Up and Use Internal Communications
Creating a New Internal Communication from a WX Process
1. Complete the fields as follows:
Field
Description
Policy
The name of the Policy assigned to the Team Members you want to view this Internal
Communication. Select Policy Lookup
, find and select the Policy you want.
Leave blank if you don't want to define the target audience by their Policy.
Policy Group
The name of the Policy Group assigned to the Team Members you want to view this
Internal Communication.
Leave blank if you don't want to define the target audience by their Policy Group.
Show To Manager
Checkbox. If checked, when a Manager views a Team Member's pages, the Internal
Communication is visible to the Team Member's manager, manager's manager, and so
on up the organization hierarchy.
Show To Other
Checkbox. If checked, when someone who is not the Team Member and not a member
of the Team Member's management hierarchy views a Team Member's pages, the
Internal Communication is visible to them.
Show To Team
Member
Checkbox. If checked, the Internal Communication is visible to Team Members viewing
their own WX pages, and not on the pages of a manager's team when viewed through
the manager's WX.
Team Member
The name of the Team Member you want to receive this Internal Communication. Use in
conjunction with Level Down
Select Team Member Lookup
Level Down
, find and select the Team Member.
The number of levels of the company hierarchy below Team Member you want to show
this Internal Communication.
For example:
• Team Member is the CEO
• Level Down is 1
The Internal Communication is visible to the CEO and C level employees - the CEO's
direct reports.
Internal
Communication
Name
The name you want to use for this Internal Communication. Used for searches. Not
displayed to end users through WX.
Tile Type
The type of Tile you want to create for this Internal Communication. Select the picklist
and choose from:
• Rich Text
• External Website
• Video
• HTML
Tile Content
Displayed if you select Rich Text as the Tile Type.
A text input field with standard formatting buttons:
Enter the summary text you want to appear on the Tile. You can also
pictures:
Fairsail WX Configuration Guide
© Fairsail 2017
embed links and
53
How to Set Up and Use Internal Communications
Creating a New Internal Communication from a WX Process
Field
Description
External Website Url
Displayed if you select External Website as the Tile Type.
Enter the url of the website you want to display in the Tile in the form:
www.example.com
Website urls are subject to your organization's access policy - make sure that your
intended target audience is authorized to access the site you want to use.
Video Url
Displayed if you select Video as the Tile Type.
Enter the url of the video you want to display in the Tile in the form:
http://www.youtube.com/watch...
Video urls are subject to your organization's access policy - make sure that your intended
target audience is authorized to access the video you want to use.
HTML
Displayed if you select HTML as the Tile Type.
Enter the html you want to be rendered in the Tile.
Detail Type
The type of Detail you want to create for this Internal Communication. Detail content is
displayed when users select the summary information displayed in the Tile.
Select the picklist and choose from:
• Rich Text
• External Website
• Video
• HTML
If your Tile contains the full message and you do not want to display a Detail panel, leave
Detail Type at its default value and leave the content fields empty.
Detail Content
Displayed if you select Rich Text as the Detail Type.
A text input field with standard formatting buttons:
Enter the
pictures:
External Website Url
text you want to appear in the Detail. You can also
embed links and
Displayed if you select External Website as the Detail Type.
Enter the url of the website you want to display in the Detail in the form:
www.example.com
Website urls are subject to your organization's access policy - make sure that your
intended target audience is authorized to access the site you want to use.
Video Url
Displayed if you select Video as the Detail Type.
Enter the url of the video you want to display in the Detail in the form:
http://www.youtube.com/watch...
Video urls are subject to your organization's access policy - make sure that your intended
target audience is authorized to access the video you want to use.
HTML
Displayed if you select HTML as the Detail Type.
Enter the html you want to be rendered in the Tile.
2. Select Save.
Fairsail WX Configuration Guide
© Fairsail 2017
54
How to Set Up and Use Internal Communications
Using Scoring for WX Internal Communications
Using Scoring for WX Internal Communications
Scoring enables your Team Members to respond to an Internal Communication with a rating and
comments. Using the Scales held in your org's Scale Library, you can choose a scale that is appropriate to
the Internal Communication - for example:
• For a catering survey asking if the recent change of supplier has been positively received, use an
Agreement scale, with possible responses ranging from definitely to definitely not.
• For a survey seeking an indication of the level of knowledge within the organization of an area that's
been proposed for commercial development, use an Expertise scale, with possible responses ranging
from Expert to None.
All scale responses have numerical values, enabling wide ranging statistical analysis.
Responses are stored for each Internal Communication.
To use scoring:
1. Set up an Internal Communication with a Scale (see page 45).
Scale must be specified so that when displayed to Team Members, the Internal Communication includes
a Score button.
2. Create a WX Process (see page 27) to host the Internal Communication.
To generate Actions for Team Members receiving the Internal Communication, on the WX Process Detail
page ensure that Score has Action is checked:
3. Team Members select Score to display the Review dialog:
Fairsail WX Configuration Guide
© Fairsail 2017
55
How to Set Up and Use Internal Communications
Using Scoring for WX Internal Communications
4. Select the picklist to display the scale values you can select:
5. Select the value you want.
6. Enter any comments in the box below.
7. Select Save
8. The score button is removed from the Internal Communication for the Team Member to prevent them
from scoring twice.
The score result is added to the Internal Communication Score Results Related List on the Internal
Communication Detail page:
Select the Internal Communication Name to display the Internal Communication Score Result Detail page:
Fairsail WX Configuration Guide
© Fairsail 2017
56
How to Set Up and Use Internal Communications
Using Scoring for WX Internal Communications
Hover over the Scale Response to view the detail:
Fairsail WX Configuration Guide
© Fairsail 2017
57
How to Set Up and Use Internal Communications
Using Confirmation for WX Internal Communications
Using Confirmation for WX Internal Communications
Confirmation enables your Team Members to confirm when they have read an Internal Communication.
• The Internal Communication can be hidden when read - that is, when the Team Member has confirmed
that they have read it - or continue to display until the End Date you have specified.
• Confirmations are stored in the WX Process Confirmations object, and can be viewed for each Team
Member through the WX Process Confirmations Related List, which you can add to the Team Member
page layout.
• You can use the fields in the WX Process Confirmation object in your reports:
o
Confirmation Date
o
Is Confirmed
o
Process Instance
o
Team Member
To use confirmation:
1. Create the WX Process (see page 27).
o
In WX Process Type, select Internal Communications.
o
Check Confirm When Read.
o
If you want the Internal Communication to be hidden when the Team Member has confirmed that
they have read it, check Hide When Read.
2. Edit the page layout for the Team Member object to add the WX Process Confirmations Related List to
the page.
Fairsail WX Configuration Guide
© Fairsail 2017
58
How to Set Up and Use Internal Communications
Embedding Social Feeds in WX
Embedding Social Feeds in WX
Use the following links for more information about embedding commonly used social feeds:
https://developer.linkedin.com/plugins
http://snapwidget.com
https://dev.twitter.com/web/embedded-timelines
Fairsail WX Configuration Guide
© Fairsail 2017
59
How to Set Up and Use Internal Communications
Picklists: Internal Communication
Picklists: Internal Communication
Internal Communication Object: Default Picklist values
Detail Type field
Location field
Tile Type field
Rich Text
Header
Rich Text
External Website
Footer
External Website
Video
SubHeader
Video
SubFooter
Internal Communication Language Object: Default Picklist values
Detail Type field
Locale field
Tile Type field
Rich Text
da
Rich Text
External Website
de
External Website
Video
en_US
Video
es
fi
fr
it
ja
ko
nl_NL
pt_BR
ru
sv
th
zh_CN
zh_TW
Fairsail WX Configuration Guide
© Fairsail 2017
60
How to Set Up and Use Internal Communications
Translation Workbench: Internal Communication
Translation Workbench: Internal Communication
Internal Communication Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Content Raw
Long Text Area (32768)
Detail Content External Website
Text Area (255)
Detail Content Video
Text Area (255)
Detail Rich Text
Rich Text Area (32768)
Detail Type
Picklist
Level Down
Number (1,0)
Location
Picklist
Policy
Lookup (Policy)
Policy Group
Text (80)
Scale
Lookup (Scale)
Show To Manager
Checkbox
Show To Other
Checkbox
Show To Team Member
Checkbox
Summary Raw
Long Text Area (32768)
Team Member
Lookup (Team Member)
Tile Content External Website
Text Area (255)
Tile Content Video
Text Area (255)
Tile Rich Text
Rich Text Area (32768)
Tile Type
Picklist
Internal Communication Instance
Object
Default Field Label
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Field Label Override
Field Type
Confirm When Read
Checkbox
Hide When Read
Checkbox
Internal Communication
Master-Detail (Internal
Communication)
Process Instance
Master-Detail (Process Instance)
Score has Action
Checkbox
Show Tile In Detail
Checkbox
Fairsail WX Configuration Guide
© Fairsail 2017
61
How to Set Up and Use Internal Communications
Translation Workbench: Internal Communication
Internal Communication Language
Object
Default Field Label
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Field Label Override
Field Type
Content
Rich Text Area (32768)
Content Raw
Long Text Area (32768)
Corporate Notice
Internal Communication
Master-Detail (Internal
Communication)
Detail Content External Website
Text Area (255)
Detail Content Video
Text Area (255)
Detail Type
Picklist
Locale
Picklist
Summary
Rich Text Area (32768)
Summary Raw
Rich Text Area (32768)
Tile Content External Website
Text Area (255)
Tile Content Video
Text Area (255)
Tile Type
Picklist
Internal Communication Score
Result Object
Default Field Label
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Field Label Override
Field Type
Comments
Long Text Area (32768)
Internal Communication
Master-Detail (Internal
Communication)
Scale Response
Lookup (Scale Response)
Team Member
Lookup (Team Member)
Fairsail WX Configuration Guide
© Fairsail 2017
62
How to Set Up Recognition
Recognition - also known as Shout Outs, Badging, Crowdsourced Performance Review - enables you to use
social performance management across your organization, giving all Team Members the ability to award
visible and immediate positive feedback to others. You decide the things you want to be awardable typically values or competencies.
Recognition is enabled by Policy and linked to a Job Profile. The Job Profile provides the list of values or
competencies you want to use for Recognition and must be provided for Recognition to work:
• In an org with more than one Policy you can roll out the process group by group.
• You can use an existing Job Profile or you can set up a Job Profile just for use with Recognition. A
dedicated Profile can have all the competencies you need, which might not be practical with an existing
Job Profile.
There are two steps to setting up and using Recognition:
1. Switch Recognition on in the Policy or Policies you want to use (see page 64).
The Policy also has settings for:
o
The Job Profile you want to use. A Job Profile must be specified.
o
Maximum numbers per Team Member per month for giving and receiving Recognition.
2. Select a WX Service and create a Recognition Process (see page 27), selecting Recognition as the WX
Process Type.
Fairsail WX Configuration Guide
© Fairsail 2017
63
How to Set Up Recognition
Policy Options: Recognition
Policy Options: Recognition
Option
Description
Recognition
Checkbox. If checked, the Recognition process is active and can be enabled for
WX users.
Recognition Job Profile
The Job Profile hosting the Job Needs you want to use for Recognition. A Job
Profile must be specified.
You can use an existing Job Profile for Team Members assigned to this Policy
or you can create a dedicated Job Profile hosting all the Job Needs for which
you want Recognition to be available.
Select Recognition Job Profile Lookup
want.
, find and select the Job Profile you
Maximum Recognition Given Per
Month
Number, optional. To restrict the number of Recognition awards that can be
made within a calendar month by each Team Member assigned to this Policy.
Maximum Recognition Received
Per Month
Number, optional. To restrict the number of Recognition awards that can be
received within a calendar month by each Team Member assigned to this
Policy.
Require Approval For Recognition
Not used.
Fairsail WX Configuration Guide
© Fairsail 2017
64
How to Set Up Recognition
Translation Workbench: Recognition
Translation Workbench: Recognition
Recognition Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Competency Library Item
Lookup (Competency Library
Item)
Giver
Lookup (Team Member)
Reason
Long Text Area (32768)
Recognition Date
Date
Show Team Member
Checkbox
Team Member
Lookup (Team Member)
Field Sets: Recognition
Recognition Object
Field Set
Purpose
Details
Fields displayed in the WX Recognition panel when giving recognition.
Fairsail WX Configuration Guide
© Fairsail 2017
65
How to Set Up a Summary Process
The WX Summary process is a highly flexible and extensible high level reporting process. In this release, you
can set up the Summary process to display Team Member information for your organization:
• The total number currently employed
• Those with birthdays in the next seven days
• Those who were new hires in the last seven days
There are two steps to setting up a Summary Process:
1. Switch Summary on in the Policy or Policies you want to use (see page 68).
2. Select a WX Service and create a Summary Process (see page 27):
o
Select Summary as the WX Process Type.
o
In Additional Information enter:
For Employee Counter
For Birthdays...
For New Hires...
contentType=employee counter
contentType=birthdays
contentType=new hires
messageToSelf=Happy Birthday!
messageToSelf=Welcome!
The contentType lines must be exactly as given.
The text following messageToSelf= forms a message displayed to Team Members included in the
report:
For a Birthdays Summary Process the message is displayed to Team Members with a birthday today.
For a New Hires Summary Process the message is displayed to all Team Members who have started
in the last seven days.
The text following messageToSelf= can contain any text string of up to 255 characters.
Summary Process tiles display:
The total number of employees with Start Dates
before today, and where Has Left is False:
There is no Detail View for the Employee Counter.
Fairsail WX Configuration Guide
© Fairsail 2017
66
How to Set Up a Summary Process
Field Sets: Recognition
The number of Team Members with birthdays in the The number of New Hires who joined the
next 7 days:
organization in the last 7 days:
Select View Details to display for each Team
Member:
Select View Details to display for each New Hire:
• Preferred Name (if available)
• Preferred Name (if available)
• Last Name
• Last Name
• Picture
• Picture
• Next birthday date
• Job Title
• A link to the Team Member's WX page
• Country
• Hire Date
• A link to the Team Member's WX page
Contact Fairsail if you wish to implement a Summary process that is not currently available.
Fairsail WX Configuration Guide
© Fairsail 2017
67
How to Set Up a Summary Process
Policy Options: Summary
Policy Options: Summary
Option
Description
Summary
Checkbox. If checked, the Summary process is active and can be configured
and enabled for WX users.
Translation Workbench: Summary Process
Summary Process Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Content Type
Text (32)
Fields
Text (255)
SObject
Text (255)
View
Text (32)
Where
Text (255)
Fairsail WX Configuration Guide
© Fairsail 2017
68
How to Set Up Year End Vacation Balance
Reporting
The WX Async Reporting Process enables team managers to generate and view a regular report on vacation
absence balances for their teams. The report presents managers with a single page view of current and
forecast predictable absence for their direct reports, with drill down into the data for sub-teams. Data is
displayed in tabbed view, with one tab for each Vacation type defined in the Absence Accrual Pattern:
Fairsail WX Configuration Guide
© Fairsail 2017
69
How to Set Up Year End Vacation Balance Reporting
Translation Workbench: Summary Process
There are five steps to setting up Async Reporting:
1. Ensure that all balance types you want to include are selected in the Absence Accrual Rule for the
Vacation type. Use the checkboxes:
o
Show Accrued Balance
o
Show Carry Over
o
Show Time in Lieu
o
Show Accrued Total
o
Show Year End Balance
2. Create a batch process to extract the data for the report (see page 71).
The report displays the data generated by the last batch and does not change the content of the report
until another batch runs.
3. Add the Async Reporting is Active checkbox to the Policy page layout, and switch on Async Reporting in
each Policy you want to use (see page 73).
4. If your team includes some members reporting vacation in hours and others reporting in days, add the
Hours to Days Conversion Factor field to the Absence Accrual Pattern page layout.
The conversion factor enables Team Total, Maximum, and Average values to be displayed in both days
and hours. Team Members reporting in different units can also be accurately sorted for display in
descending value order. Values for individual team members are displayed in their reporting units - days
or hours.
Enter a value in the field to act as a multiplier when converting hourly values to daily equivalents; if left
blank Hours to Days Conversion Factor defaults to 0.125 for an 8 hour day.
5. Select a WX Service and create the Process instance (see page 27).
Use the Additional Information field to enable data display and select the content of the Tile (see page
74). The Process does not display any data if Additional Information is left blank.
Async Reporting requires the separate Fairsail Async Reporting package in addition to Fairsail Human Capital
Management.
Fairsail WX Configuration Guide
© Fairsail 2017
70
How to Set Up Year End Vacation Balance Reporting
Setting up a Batch to Update Report Data
Setting up a Batch to Update Report Data
The Async Reporting process uses a regular batch process to extract vacation absence data from your org.
The reporting process does not display any data - Tile and Detail views are empty - until the batch has run
for the first time.
Fairsail also recommends that you run the batch to update data after installing an updated Async Reporting
package.
To set up the batch:
1. Go to Setup > App Setup > Develop > Apex Classes
2. Select Schedule Apex:
3. On the Schedule Apex page, complete the fields as follows:
Job Name
A meaningful name for the batch process, such as Absence Reporting.
Apex Class
The Apex Class that runs the batch job. Select Apex Class Lookup
AsyncReportingAbsenceSchedule Apex Class.
Frequency
When the batch is to run. Select from:
and select the
• Weekly
Select the day of the week. To run on more than one day every week, select the days
you want the batch to run.
To run more than one batch on a given day, set up separate batches with your
desired combinations of day of the week and Preferred Start Time; for example, one
batch on Monday at 8:00 AM, one batch on Monday at 9:00 AM.
• Monthly
Select from:
o The day of the month - 1, 2, 3...
o The nth occurrence of a particular day; for example, the third Monday of every
month.
Start
The date you want the first batch to run. If you set Start to today's date and you want
the batch to run today, make sure Preferred Start Time is later than the current time.
End
The date you want the batch to stop running.
Preferred Start Time
Picklist. Select the picklist and choose the time of day you want the batch to run. Batches
may run after the Preferred Start Time if the job queue is busy at the time.
4. Select Save.
Fairsail WX Configuration Guide
© Fairsail 2017
71
How to Set Up Year End Vacation Balance Reporting
Setting up a Batch to Update Report Data
5. Check that the batch is scheduled to run when you expect it:
a. Go to Setup > Administration Setup > Monitoring > Scheduled Jobs
b. Check the Next Scheduled Run value for the new batch job.
You cannot amend batch details after you have saved - you must delete and recreate to make changes.
Each time the batch runs, data is written to an Async Report Run record with data for each Team Member held in an
Async Report Row object. You can inspect the data in JSON (JavaScript Object Notation) format for a Team Member
by going to the Team Member Detail page and scrolling down to the Async Report Rows Related List. The Async
Report Rows Related List is not displayed by default and must be added to the page layout.
Running a Batch Immediately
If you need to run a batch to produce or update reporting data immediately - during initial set up and
testing, or after adding or correcting Team Member data for example - you can follow these steps:
1. Open the Developer Console.
2. Select Debug > Open Execute Anonymous Window.
3. In the Enter Apex Code window enter:
new fAsync.AsyncReportingAbsenceSchedule().execute(null);
4. Select Execute.
The batch runs immediately and generates the data for year end vacation reporting.
Fairsail WX Configuration Guide
© Fairsail 2017
72
How to Set Up Year End Vacation Balance Reporting
Policy Options: Async Reporting
Policy Options: Async Reporting
Option
Description
Async Reporting
Checkbox. If checked, the Async Reporting process is active and can be enabled
for WX users.
This option is not displayed on the Policy page by default. To add the option to
the page:
1. Go to Setup > App Setup > Create > Objects
2. Scroll down to the Policy object and select the Label.
3. Scroll down to Field Sets and select Edit for the Additional Policies Field Set.
4. Drag and drop Async Reporting into the Field Set.
5. Select Save.
Fairsail WX Configuration Guide
© Fairsail 2017
73
How to Set Up Year End Vacation Balance Reporting
Enabling Data Display and Configuring Tile Content
Enabling Data Display and Configuring Tile Content
Before the Async Reporting process can display data in the Tile or Detail views you must add valid content
to the Additional Information field for the Process Instance, and check the relevant boxes in the Absence
Accrual Rule.
Valid Additional Information content:
• Enables data display in Tile and Detail views. Any valid content displays data for all selected balances in
the Detail View.
• Selects the summary data to display on the Tile:
Choose from the values in the table:
To display in the
Tile...
In Additional Information enter...
In Absence Accrual Rule
check...
Total Amount Taken
report=Absence Reporting
Show Accrued Total
summaryField=fHCM2__Process_Absences
Year End Balance
report=Absence Reporting
Show Year End Balance
summaryField=fHCM2__Process_Absence_Year_End_Balance
Absence Accrued
Current Balance
report=Absence Reporting
Time in Lieu
report=Absence Reporting
Show Accrued Balance
summaryField= fHCM2__Process_Absence_Accrued_Balance
Show Time In Lieu
summaryField= fHCM2__Process_Absence_Time_In_Lieu
Vacation Carry Over
report=Absence Reporting
Show Carry Over
summaryField= fHCM2__Process_Absence_Carry_Over
Total Accrued
Balance + Carry Over
+ Time in Lieu
report=Absence Reporting
Show Accrued Balance
summaryField=fHCM2__Global_Total
Show Carry Over
Fairsail WX Configuration Guide
Show Time In Lieu
© Fairsail 2017
74
How to Set Up Year End Vacation Balance Reporting
Translation Workbench: Async Reporting
Translation Workbench: Async Reporting
Absence Accrual Pattern Object
(HCM)
Default Field Label
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Field Label Override
Hours to Days Conversion Factor
Field Type
Number (2,3)
Async Report Row Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Async Report Run
Master-Detail (Async Report
Run)
Dimension
Text (10)
Group
Text (255)
JSON Data
Long Text Area (32768)
Team Member
Lookup (Team Member)
Async Report Run Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Async Report
Master-Detail (Async Report)
Complete
Checkbox
Policy Object (Async Reporting)
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Async Reporting is Active
Checkbox
Reporting
Checkbox
Fairsail WX Configuration Guide
© Fairsail 2017
75
How to Set Up Year End Vacation Balance Reporting
Translation Workbench: Async Reporting
WX Report Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
API Name
Text (80)
Base Object
Text (255)
Chart Default
Picklist
Description
Long Text Area (2048)
Filter Logic
Text (255)
Level Down
Number (1,0)
Policy
Lookup (Policy)
Policy Group
Text (80)
Show Data for Report Levels Down
Picklist
Show Data For Team Member
Checkbox
Show In Team
Checkbox
Show In Team Member
Checkbox
Team Member
Lookup (Team Member)
Type
Picklist
WX Report Field Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Aggregate
Picklist
Full Field Name
Formula (Text)
Header Label
Text (255)
Is Chartable
Checkbox
Order
Number (5,0)
Path
Text (244)
Sort By
Picklist
Summary
Picklist
WX Report
Master-Detail (WX Report)
Fairsail WX Configuration Guide
© Fairsail 2017
76
How to Set Up Year End Vacation Balance Reporting
Translation Workbench: Async Reporting
WX Report Filter Object
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Default Field Label
Field Label Override
Field Type
Full Field Name
Formula (Text)
Operator
Picklist
Order
Number (5,0)
Path
Text (255)
Value
Text (255)
WX Report
Master-Detail (WX Report)
Fairsail WX Configuration Guide
© Fairsail 2017
77
How to Set Up Payslips
The WX Payslips Process enables you to display payslip information to Team Members. The process draws
on data written to the Payflow Line object and requires a configured Payflow Service to write that data,
typically by interfacing with a payroll service. The information displayed to Team Members is controlled by
a set of three Payflow Line Field Sets, for Tile, Detail Summary, and Detail views. Fields selected for display
must be included in the mappings to and from the Payroll Lines defined in the Payflow Service.
There are four steps to setting up Payslips:
1. Set up the Payflow Service to generate the data. Refer to the Payflow Implementer's Guide for more
information. Use the File Upload Configure options.
2. Configure the Payflow Line Field Sets to define the information displayed to Team Members (see page
79).
3. Select a WX Service to host the Payslips Process and create the Process instance (see page 27). Select
Payslips as the WX Process Type.
4. Switch on Payslips in each Policy you want to use (see page 79).
The WX Process displays blank Tile and Detail views until the Payflow Service has run its first successful
upload batch.
As an HR Manager or Administrator with access the Employment Records for your Team Members you can
view and edit the data loaded by each Payflow Batch - go to the Payflow Lines Related List on the Team
Member's Employment Record (see page 80).
Fairsail WX Configuration Guide
© Fairsail 2017
78
How to Set Up Payslips
Policy Options: Payslips
Policy Options: Payslips
If the Payslips checkbox is not displayed:
1. Go to Setup > App Setup > Create > Objects
2. Select the Label for the Policy object.
3. Select Field Sets.
4. Select Edit for the Additional Policies Field Set.
5. Drag and drop the Payslips field into the Field Set.
6. Select Save.
Option
Description
Payslips
Checkbox. If checked, the Payslips process is active and can be enabled for WX
users.
Field Sets: Payslips
Payflow Line Object
Field Set
Purpose
Payroll Line Details
WX only. Fields displayed in the Payslips Detail View, individual Payslip detail.
Payroll Line Summary
WX only. Fields displayed in the Payslips Detail view, summary table.
Payroll Line Tile
WX only. Fields displayed in the Payslips Tile.
Fairsail WX Configuration Guide
© Fairsail 2017
79
How to Set Up Payslips
Viewing and Editing Payslip Data through the HR Manager Portal
Viewing and Editing Payslip Data through the HR Manager
Portal
Payslip data generated for a Team Member by a Payflow Service is stored in the Payflow Lines Related List
on the Team Member's Employment Record.
1. Go to the Team Members tab and select the Employment Record for the Team Member.
2. In the Employment Record select the Payflow Lines Related List.
If the Payflow Lines Related List is not visible:
a. Select Edit Layout.
b. In the left panel select Related Lists.
c. Drag and drop the Payflow Lines Related List into position on the page layout.
d. Select Save.
Fairsail displays the Payflow LInes for the Team Member:
To change the column content:
1. On the Employment Record select Edit Layout.
2. In the left panel select Related Lists.
3. On the Payflow Lines Related List select Properties
.
4. In the Related List Properties - Payflow Lines dialog use Add and Remove to customize the fields
displayed as columns.
5. Select OK to close the dialog.
6. Select Save to save the changes you have made and redisplay the Employment Record.
Fairsail WX Configuration Guide
© Fairsail 2017
80
How to Set Up Payslips
Viewing and Editing Payslip Data through the HR Manager Portal
To edit a Payflow Line:
1. Select Edit for the Payflow Line.
Fairsail displays the Payflow Line Edit page:
2. Make the changes and select Save.
Fairsail WX Configuration Guide
© Fairsail 2017
81
How to Set Up Compensation Planning
Fairsail Compensation Planning comprises:
• Salary Planning
• Bonus Planning
Compensation Planning is activated through:
• Policy options
• Configuring fields as the Salary Pot field and Bonus Pot field.
These fields each contain a formula that calculates the amounts to be recommended.
• Field Sets
The Team Member object includes field sets controlling the fields displayed for managers when
compensation planning:
o
Bonus Planning holds the fields displayed on the manager's bonus planning page.
o
Salary Planning holds the fields on the manager salary plan page.
o
Salary Planning Team holds the fields displayed on the team salary planning table.
When setting up a WX Compensation Plan process follow the standard procedure (see page 27) and select
Salary Plan as the WX Process Type.
• Use the Salary Plan Process Type for all compensation planning - bonus plan and salary plan.
• Use Policy settings to control compensation plan coverage - bonus plan or salary plan, or both - and
manager access.
• Use the Configure page fields Salary Pot Field and Bonus Pot Field to reference the formula fields that
return the amounts to be recommended.
Fairsail WX Configuration Guide
© Fairsail 2017
82
How to Set Up Delegated Access for Assistants
WX Delegated Access is supported through the HR Manager Portal:
• The Roles tab.
You can add the Roles tab to your display using Customize My Tabs on the All Tabs page. Roles are used
to map assistants to managers for defined processes.
• Assistant To and Assisted By Related Lists displayed on the Team Member detail page.
You can add these Related Lists to your display using the Edit Layout link on any Team Member detail
page.
Assistants are granted access to the defined Manager's view of the processes included in the Role.
Guidelines:
• By default, to set up WX Delegated Access you need Administrator level access to the HR Manager
Portal.
• Users with HR Manager level access can define Assistant Assignments but they cannot define the
Processes for a Role.
• You can restrict each Role to a single process, for example, Absence. Restricting the number of
processes makes it easier to manage Role assignment, for example:
o
Use one C-level Absence Assistant Role to map all C-level managers to one or more Executive
Assistants for delegating absence approval when managers are not available.
o
Use one South Africa PAF Assistant Role to map all HR Requests originating from regional managers
to a single senior assistant during a reorganization.
• Setting up Delegated Access for the Absence process gives the Assistant access to the Absence process
for all the manager's direct reports
To set up Delegated Access:
1. Define the Role.
Each Role enables you to map managers to assistants for defined processes.
2. Add the Processes you want to include for the Role.
3. Add Managers and Assistants you want to use the Role.
Fairsail WX Configuration Guide
© Fairsail 2017
83
How to Set Up Non-HCM Processes
Fairsail WX Configuration Guide
© Fairsail 2017
84
How to Set Up Non-HCM Processes
Internal Recruitment
Internal Recruitment
Internal Recruitment functionality is delivered through two dedicated WX Processes:
• Internal Portal
Enables Team Members to:
o
View a list of internal vacancies, supplied by Fairsail Recruit.
o
Apply for displayed vacancies.
o
Nominate someone else for displayed vacancies
• My Applications
Displays a list of the Team Member's applications for internal vacancies, including:
o
A summary of the current status of each.
o
Links to enable completion of outstanding forms and tests, to accept or decline invitations to
interviews or other events, and to supply requested references.
o
A button to withdraw an application.
Configuration is the same in WX as it is for the Internal Recruitment process in the Collaboration Portal with
the exceptions given in this section.
Relevant Field Sets
Fairsail WX Configuration Guide
© Fairsail 2017
85
How to Set Up Non-HCM Processes
Internal Recruitment
Fairsail WX Configuration Guide
© Fairsail 2017
86
How to Set Up Non-HCM Processes
Hiring Manager
Hiring Manager
1. Enable the appropriate level of access for Hiring Managers in the Recruit Configure page:
a. Go to Setup > App Setup > Installed Packages and select Configure for the Fairsail Recruit package.
b. Choose the appropriate settings for the three Hiring Manager options:
Hiring Manager Show All Applications
Checkbox. If checked, the Hiring Manager sees all Applications for
all Vacancies where they are the Hiring Manager.
If unchecked, you can use the Show To Hiring Manager setting
when defining a Selection Stage for a Vacancy, to show all
Applications reaching that stage and all following stages.
Hiring Manager Assess All Stages
Checkbox. If checked the Hiring Manager can be an assessor for all
selection stages for all Vacancies where they are the Hiring
Manager.
If unchecked, you can use the Is Hiring Manager Stage setting when
defining a Selection Stage for a Vacancy, to specify that the stage
must be assessed by the Hiring Manager.
Hiring Manager Assessment Has
Outcome
Checkbox. If checked the Hiring Manager assessment form has
picklists for Outcome and Next Stage, enabling the Hiring Manager
to control the course of Applications.
2. Ensure the Hiring Manager field is included in the Vacancy object, Vacancy Details Field Set:
3. Define a Hiring Manager for each Recruit Vacancy as required.
4. Ensure that the relevant Field Sets (see page 88) are correctly defined for Hiring Manager visibility.
5. Enable the Hiring Manager process for Team Members by selecting the Policy option in the Recruitment
section:
Hiring Manager Is Active
Checkbox. If checked, Hiring Managers can see a list of their open
Vacancies from Fairsail Recruit in WX.
Select View Details for a Vacancy to display the fields in the Vacancy
object, Hiring Manager List Field Set.
Selecting to view a Vacancy displays the fields in the Vacancy object,
Hiring Manager Details Field Set.
6. Create a WX Hiring Manager process for the WX Service(s) as required.
The WX Hiring Manager process displays just those vacancies to each Hiring Manager where they are
defined as the Hiring Manager.
Fairsail WX Configuration Guide
© Fairsail 2017
87
How to Set Up Non-HCM Processes
Hiring Manager
Relevant Field Sets
Fairsail WX Configuration Guide
© Fairsail 2017
88
How to Set Up Non-HCM Processes
Hiring Manager
Fairsail WX Configuration Guide
© Fairsail 2017
89
How to Set Up Non-HCM Processes
Hiring Manager
Fairsail WX Configuration Guide
© Fairsail 2017
90
How to Set Up Non-HCM Processes
Hiring Manager
Fairsail WX Configuration Guide
© Fairsail 2017
91
WX Options on the HCM Configure Page
The Fairsail HCM Configure page includes a WX Setup section:
Complete the fields as follows:
WX Base Color
The base color used to derive the range of tints used for the WX display. You can:
• Enter the hexadecimal value of the RGB color code you want to use, in the
form:
#[Red_value][Green _value][Blue_value]
For example:
#D46215
• Select the field to display a color picker, then select the color you want to use.
More information (see page 102)
Company Logo
The name of the Static Resource holding the logo image you want to use at the
head of the WX page.
More information (see page 100)
Minimize Network Traffic
Checkbox. If checked, Fairsail groups network requests when building the initial
WX page for display, resulting in faster initial page load.
More information (see page 94)
Use Cache
Checkbox. If checked, WX uses the Salesforce Platform Cache Partition to store
elements of the display for re-use during the same session. You must also
configure Platform Cache (Setup > App Setup > Develop > Platform Cache).
More information (see page 95)
iOS Push App
Fairsail WX Configuration Guide
Do not use.
© Fairsail 2017
92
How to Optimize WX Performance
Fairsail aims to build WX so that pages load as quickly as possible, and our policy of continuous
improvement means that performance enhancements can form a part of each and every release. To take
advantage of the best available performance, make sure you have the latest available version installed.
There are two additional steps you can take to further optimize the performance of WX in your org:
• Switch on the Minimize Network Traffic option (see page 94).
Accelerate initial page loading by grouping data requests to the server.
• Switch on platform caching (see page 95).
Accelerate subsequent page loading by temporarily storing content already loaded.
Fairsail WX Configuration Guide
© Fairsail 2017
93
How to Optimize WX Performance
Speeding Up WX Initial Page Loading
Speeding Up WX Initial Page Loading
By default, Fairsail sends multiple requests across the network when building the initial WX page for
display. You can change this behavior by selecting a configuration option to group requests, resulting in
faster initial page load:
1. Go to Setup > App Setup > Installed Packages.
2. Select Configure next to Fairsail Human Capital Management.
3. On the Fairsail HCM Configure page, scroll down to the WX Setup section and check Minimize Network
Traffic:
4. Select Save.
Fairsail WX Configuration Guide
© Fairsail 2017
94
How to Optimize WX Performance
Speeding Up WX After Initial Page Loading
Speeding Up WX After Initial Page Loading
Caching offers a customizable option to improve page loading times after initial display. Fairsail enables you
to use Salesforce Platform Cache Partition functionality to store elements of the WX display for re-use
during the same session:
1. Go to Setup > App Setup > Installed Packages.
2. Select Configure next to Fairsail Human Capital Management.
3. On the Fairsail HCM Configure page, scroll down to the WX Setup section and check Use Cache:
4. Go to Setup > App Setup > Develop > Platform Cache.
Fairsail displays the Platform Cache Partition page:
By default, each org has available cache space of 10MB which you can allocate to one or more
partitions. Total allocated cache cannot exceed 10MB.
The Viewports partition is assigned to WX and is used to cache elements of the displayed page. To start
with, Viewports is set to 0MB.
Fairsail WX Configuration Guide
© Fairsail 2017
95
How to Optimize WX Performance
Speeding Up WX After Initial Page Loading
5. In the Action column, select Edit for the Viewports partition:
Fairsail displays the Platform Cache Partition Edit page for Viewports:
Fairsail WX Configuration Guide
© Fairsail 2017
96
How to Optimize WX Performance
Speeding Up WX After Initial Page Loading
6. In the Session Cache Allocation section, Organization field, use the arrow buttons to select the size of
partition you want to allocate. Minimum is 5MB, maximum is 10MB:
Fairsail recommends setting Session Cache to the maximum available size, 10MB.
Totals display for Org Cache and Total Allocations as you select the size of partition.
7. Select Save.
Fairsail displays the Platform Cache Partition detail page.
The session cache you created is available immediately.
Fairsail WX Configuration Guide
© Fairsail 2017
97
Changing the Appearance of Your WX
Fairsail WX Configuration Guide
© Fairsail 2017
98
Changing the Appearance of Your WX
How to Change the Fairsail WX Title
How to Change the Fairsail WX Title
You can use your own title for Fairsail WX. You can apply your title by user language or by Policy, or use the
Policy setting to further customize a language setting.
The default title supplied by Fairsail is Fairsail WX.
To change the title for a user language, so that all users with that language assigned see the new title:
1. Go to Setup > App Setup > Create > Custom Labels.
2. Select the label name Collaboration Portal Title.
3. In the Local Translations / Overrides Related List, select New Local Translations / Overrides.
Fairsail displays the New Translation page.
4. In the Translation Information section:
a. Select the Language.
If your organization uses a single language and you want to change the title for all users, choose the
default language.
Fairsail typically defaults to US English - listed in the picklist as English. UK English is listed as English
(UK).
b. In Translation Text enter the new title exactly as you want it to appear.
5. Select Save.
Your new title is saved and appears in the Local Translations / Overrides Related List for the Custom Label.
To display a different title for each of a range of languages, repeat the steps for each language.
The next time a user with the language assigned logs in or refreshes WX, the new title is displayed.
You can also specify a different title for Team Members assigned to a Policy. A Policy setting overrides the
language setting. To change the title for a Policy:
1. Select the Policies tab.
2. Select Edit for the Policy controlling the version of WX you want to rename.
3. Scroll down to the WX section at the bottom of the Policy.
4. In WX Title, enter the text label you want to use for WX.
5. Select Save.
Next time you login or refresh WX, the new title is displayed:
Fairsail WX Configuration Guide
© Fairsail 2017
99
Changing the Appearance of Your WX
How to Change the Fairsail Logo
How to Change the Fairsail Logo
You can load your own logo to replace the default Fairsail logo. Logo display is controlled on two levels:
• By Configure page setting, enabling you to use an organization-wide logo as a default.
• By Policy setting, enabling you to use different logos for different Policies used by your organization. A
logo set at the Policy level overrides the default logo set on the Configure page.
Logos are loaded as Static Resources for your org - each logo must have a unique name within your org.
• Use an image file in .gif, .jpeg., or .png format.
• Oversized logos are resized maintaining the aspect ratio, but to optimize image quality use an image of
no more than 80px high. The banner strip holding the logo is 100px high and is not resized.
• Check your logo for compatibility with all screen sizes you plan to use - long logos can be compressed
and become unreadable at smaller screen sizes.
1. Go to Setup > App Setup > Develop > Static Resources.
2. Select New.
Fairsail displays the Static Resource Edit page.
3. Complete the fields as follows:
Name
Enter the name you want to use for this logo.
Description
A brief description for the file as you want it displayed in the list of Static Resources.
File
Select Browse, find and select the image file you want to use.
4. Select Save.
Fairsail loads the file and adds it to the list of Static Resources for your organization.
Fairsail WX Configuration Guide
© Fairsail 2017
100
Changing the Appearance of Your WX
How to Change the Fairsail Logo
5. Repeat the procedure to add as many logo files as you need.
6. Go to Setup > App Setup > Installed Packages and select Configure for the Fairsail Human Capital
Management package.
7. On the Configure page scroll down to the WX Setup section and in Company Logo enter the name of the
Static Resource holding the default logo for your organization.
8. Select Save.
9. To add a logo to display to Team Members assigned to a specific Policy:
a. Select the Policies tab.
b. Select Edit for the Policy controlling the version of WX you want to rebrand.
c. Scroll down to the WX section at the bottom of the Policy.
d. In WX Logo, enter the name of the Static Resource holding the logo.
e. Select Save.
Next time you login or refresh WX, the new logo is displayed:
Fairsail WX Configuration Guide
© Fairsail 2017
101
Changing the Appearance of Your WX
How to Change the Base Color
How to Change the Base Color
Fairsail WX uses a single base color to drive the range of tints used for the display. The tints are calculated
as percentages of the base color.
Change the base color to match your requirements - all tints are automatically calculated and implemented
across the display.
You have two levels of control over the base color:
• A generic setting used as a default across your organization.
• A Policy-specific setting that overrides the generic setting for all users of a Policy.
To change the generic base color:
1. Go to Setup > App Setup > Installed Packages. For Fairsail Human Capital Management select
Configure.
2. Scroll down to the WX Setup section.
3. In Wx Base Color you can:
o
Enter the hexadecimal value of the RGB color code you want to use, in the form:
#[Red_value][Green _value][Blue_value]
For example:
#D46215
Fairsail WX Configuration Guide
© Fairsail 2017
102
Changing the Appearance of Your WX
How to Change the Base Color
o
Select the field to display a color picker, then select the color you want to use.
4. Select Save.
To change the base color for a Policy:
1. Select the Policies tab.
2. Select Edit for the Policy controlling the version of WX you want to rename.
3. Scroll down to the WX section at the bottom of the Policy.
4. In WX Colour enter the hexadecimal value of the RGB color code you want to use, in the form:
#[Red_value][Green _value][Blue_value]
For example:
#BF3DA1
5. Select Save.
Next time you open or refresh WX, the new base color is used:
Translation Workbench: Wx Base Colour Setup
WX Base Colour Setup
Object
Default Field Label
Use Setup > Administration Setup > Translation Workbench > Override to
rename these custom fields
Field Label Override
Wx Base Colour
Fairsail WX Configuration Guide
Field Type
Text (10)
© Fairsail 2017
103
Changing the Appearance of Your WX
Guidelines for Team Member Pictures
Guidelines for Team Member Pictures
Fairsail WX uses circular images for Team Members - in the Service Bar, People Bar, Organization Chart and
so on. The images are cropped and resized from typically rectangular source images, taking the shortest
image dimension as the diameter of the circle, and centering the circle on the rectangle:
Maximum and minimum resized images are:
• Maximum: 100px diameter circle for the Service Bar.
• Minimum: 45px diameter circle for the People Bar.
For best results, follow these guidelines for the source image:
• Square or nearly square.
• Face centered in the image.
• Minimum border on the shortest dimension - with the face nearly filling the frame.
• Images are resized regardless of the size of the original, but bear in mind the maximum file size limit of
200KB.
Fairsail WX Configuration Guide
© Fairsail 2017
104
How to Add a Supported Language
If your org is set up as a multi-language org you can add support for more than one language. Supported
languages are those for which you want to load local language translations so that your users can see them.
Fairsail managed packages are supplied with a range of translations already available and maintained;
check with your administrator to find out which languages your organization already has available.
Adding a language is a three step process:
1. Make the language available (see page 106).
2. Add the language to your org (see page 108).
3. Load translations (when none are provided) or override provided translations for further customization.
You can also change the default language used throughout your org for any available language (see page
111).
To display translations for WX Service Names and Process Labels, you must load them as Custom Labels
supported with a Static Resource text file holding the Label Names (see page 31).
Fairsail WX Configuration Guide
© Fairsail 2017
105
How to Add a Supported Language
Checking and Adding Available Languages
Checking and Adding Available Languages
To check Available Languages:
• Go to Setup > Administration Setup > Company Profile > Language Settings
Fairsail displays the Language Settings page:
There are three sets of languages available:
• Fully Supported
All Salesforce standard terminology is available, including Setup and Setup Help.
• End User Languages
Salesforce standard terminology is available, but not Setup or Setup Help. Check Enable End User
Languages to add the list of End User Languages to the list of Available Languages.
• Platform Only Languages
All terminology must be separately translated. Check Enable Platform Only Languages to add the list of
Platform Only Languages to the list of Available Languages.
Fairsail WX Configuration Guide
© Fairsail 2017
106
How to Add a Supported Language
Checking and Adding Available Languages
Full Fairsail terminology can be made available for languages in all three sets. Check with your Fairsail
Administrator to find out which languages have been implemented in your organization.
Adding languages to the list of Available Languages does just that - it does not make those languages visible
through Fairsail. To enable you to load translations for a language and make that language visible to users,
you must:
1. Make sure that the language is in the list of Available Languages.
2. Select the language in the list of Available Languages
3. Select Add to move it to the list of Displayed Languages.
The list of Displayed Languages is used to populate the list of languages you can choose to support in your
organization.
Fairsail WX Configuration Guide
© Fairsail 2017
107
How to Add a Supported Language
Adding a Language to Your Org
Adding a Language to Your Org
When you have added a language to the list of Displayed Languages (see page 106), you can add that
language to your org so that you can support it with translations.
1. Go to Setup > Administration Setup > Translation Workbench > Translation Settings
Fairsail displays the list of Supported Languages for your organization:
The default list of Supported Languages includes all those supplied with the Fairsail managed packages
to which you subscribe, and may therefore be different for different organizations.
If a language is listed here, you can customize it by adding a user as a translator, and then getting that
user to login and make the changes you want.
Fairsail WX Configuration Guide
© Fairsail 2017
108
How to Add a Supported Language
Adding a Language to Your Org
2. Select Add.
Fairsail displays the New Language page:
3. Select the Language picklist and select the language you want to add.
Languages in the picklist are all those:
o
In the table of Available Languages on the Language Settings page (see page 106).
AND
o
In the table of Displayed Languages on the Language Settings page (see page 106).
EXCEPT
o
The languages already selected as Supported Languages.
4. In the Identify Translators for this Language section select one or more displayed users from the
Available List or use Search Users to find one, then select Add to move them to the Selected List.
5. Select Save.
6. Make sure that all translators have the View Setup and Configuration permission, either through their:
o
Profiles, Administrative Permissions
OR
o
Permission Sets, System Permissions
Fairsail WX Configuration Guide
© Fairsail 2017
109
How to Add a Supported Language
Adding and Amending the Language Selector Picklist
Adding and Amending the Language Selector Picklist
1. Go to Setup > App Setup > Installed Packages.
2. Select Configure next to Fairsail Human Capital Management.
Fairsail displays the Configure page for Fairsail HCM.
3. In Available Languages add a line for each language you want to be available for selection. Each line
must be of the form:
[Name of the language as you want it displayed in the picklist]:[language code]
For example:
Française:fr
Relevant language codes are:
o
For English: en_US
o
For German: de
o
For Simplified Chinese: zh_CN
o
For Italian: it
o
For Czech: cs
o
For Korean: ko
o
For Dutch: nl_NL
o
For Japanese: ja
Fairsail uses nl_NL for Flemish
(Belgisch-Nederlands)
o
For Polish: pl
o
For Portuguese (Brazilian): pt_BR
o
For Spanish: es
o
For Swedish: sv
o
For Turkish: tr
o
For Finnish: fi
o
For French: fr
o
For French (Canadian): fr_CA
When complete, Available Languages might contain the following entries:
English:en_US
Čeština:cs
Deutsch:de
Español:es
Français:fr
日本語:ja
한국어:ko
Svenska:sv
4. Select Save.
5. Go to WX and check that the Language Selector picklist at the bottom of the page displays the languages
you have set up.
Check that the translated terms display for your chosen languages by selecting the language in the
picklist.
Fairsail WX Configuration Guide
© Fairsail 2017
110
Changing the Default Language
To check the default language for your org:
• Go to Setup > Administration Setup > Company Profile > Company Information.
Fairsail displays the Organization Detail page for your org:
Default Language shows the language used for display if no other language is available or selected.
To change the Default Language:
1. On the Organization Detail page for your org,select Edit.
Fairsail displays the Organization Edit page.
2. In the Locale Settings section, select the picklist for Default Language and select the language you want
to use.
You can add any language available to you on Fairsail.
Fairsail WX Configuration Guide
© Fairsail 2017
111
Locale Codes
This section contains tables of locale codes:
• Ordered alphabetically by Locale (see page 113).
• Ordered alphabetically by Code (see page 115).
Fairsail WX Configuration Guide
© Fairsail 2017
112
Locale Code
Albanian sq
Arabic ar
Armenian hy
Basque eu
Bengali bn
Bosnian bs
Bulgarian bg
Chinese (Simplified) zh_CN
Chinese (Traditional) zh_TW
Croatian hr
Czech cs
Danish da
Dutch nl_NL
English (Australia) en_AU
English (Canada) en_CA
English (India) en_IN
English (Malaysia) en_MY
English (Philippines) en_PH
English (UK) en_GB
English en_US
Estonian et
Finnish fi
French (Canada) fr_CA
French fr
Georgian ka
German (Austria) de_AT
German (Switzerland) de_CH
German de
Greek el
Hebrew iw
Hindi hi
Hungarian hu
Icelandic is
Indonesian in
Irish ga
Italian it
Fairsail WX Configuration Guide
© Fairsail 2017
113
Locale Codes
Adding and Amending the Language Selector Picklist
Locale Code
Japanese ja
Korean ko
Latvian lv
Lithuanian lt
Luxembourgish lb
Macedonian mk
Malay ms
Maltese mt
Montenegrin sh_ME
Norwegian no
Polish pl
Portuguese (Brazil) pt_BR
Portuguese (Portugal) pt_PT
Romanian (Moldova) ro_MD
Romanian ro
Romansh rm
Russian ru
Serbian (Cyrillic) sr
Serbian (Latin) sh
Slovak sk
Slovenian sl
Spanish (Mexico) es_MX
Spanish es
Swedish sv
Tagalog tl
Tamil ta
Thai th
Turkish tr
Ukrainian uk
Urdu ur
Vietnamese vi
Welsh cy
Fairsail WX Configuration Guide
© Fairsail 2017
114
Code Locale
ar Arabic
bg Bulgarian
bn Bengali
bs Bosnian
cs Czech
cy Welsh
da Danish
de German
de_AT German (Austria)
de_CH German (Switzerland)
el Greek
en_AU English (Australia)
en_CA English (Canada)
en_GB English (UK)
en_IN English (India)
en_MY English (Malaysia)
en_PH English (Philippines)
en_US English
es Spanish
es_MX Spanish (Mexico)
et Estonian
eu Basque
fi Finnish
fr French
fr_CA French (Canada)
ga Irish
hi Hindi
hr Croatian
hu Hungarian
hy Armenin
in Indonesian
is Icelandic
it Italian
iw Hebrew
ja Japanese
ka Georgian
Fairsail WX Configuration Guide
© Fairsail 2017
115
Locale Codes
Adding and Amending the Language Selector Picklist
Code Locale
ko Korean
lb Luxembourgish
lt Lithuanian
lv Latvian
mk Macedonian
ms Malay
mt Maltese
nl_NL Dutch
no Norwegian
pl Polish
pt_BR Portuguese (Brazil)
pt_PT Portuguese (Portugal)
rm Romansh
ro Romanian
ro_MD Romanian (Moldova)
ru Russian
sh Serbian (Latin)
sh_ME Montenegrin
sk Slovak
sl Slovenian
sq Albanian
sr Serbian (Cyrillic)
sv Swedish
ta Tamil
th Thai
tl Tagalog
tr Turkish
uk Ukrainian
ur Urdu
vi Vietnamese
zh_CN Chinese (Simplified)
zh_TW Chinese (Traditional)
Fairsail WX Configuration Guide
© Fairsail 2017
116
Glossary of Terms
Authorizing Manager
Internal Communications
The person in an organization who approves a
vacancy requisition before recruitment can start.
Vacancy requisitions are typically created by or
for a Hiring Manager. Fairsail enables you to
define an Authorizing Manager for each new
vacancy.
A type of WX Process enabling you to create and
display a range of communications for display
through Fairsail WX. Communications can be rich
text notices, videos, or external websites. You can
create localized versions of each communication
and control who sees what.
Badge
Internal Portal
In Fairsail WX, a highlighted number displayed
beside a Service or Process name indicating how
many Actions are outstanding for that Service or
Process.
Detail View
In Fairsail WX, Detail View displays detailed
information for a Process and enables you to edit
that information, subject to the permissions that
apply in your organization. Access Detail View by
selecting a Process in the Navigation Bar or
Service Bar, or by selecting View Details on a Tile.
Hiring Manager
The person in an organization who requests a
new Team Member to fill a new or existing
vacancy. The new Team Member will typically
report to the Hiring Manager when they join.
Vacancy requisitions created by or for a Hiring
Manager are usually submitted to a more senior
Authorizing Manager for approval. Fairsail
enables you to define a Hiring Manager for each
new vacancy and to give that person access to all
associated applications and candidates through a
single process in Fairsail WX - the Hiring Manager
process.
Fairsail WX Configuration Guide
Part of Fairsail's recruitment functionality.
Enables Team Members to view and apply for job
vacancies in your organization. Delivered as a
single process in Fairsail WX, and typically used
with the My Applications process.
My Applications
Part of Fairsail's recruitment functionality.
Enables Team Members to view and update the
current status of applications they have made for
internal vacancies. Delivered as a single process
in Fairsail WX, and typically used with the Internal
Portal process.
Navigation Bar
In Fairsail WX, the left panel giving access to
information about you and your team.
Information is grouped into Services, such as
Performance, Time & Attendance, or Personal
Details. Services are broken down into Processes;
for example the Performance Service might
include the Objectives, Performance Review, and
Training Processes.
Select a Service to display summary information
in Tiles for all the Processes in that Service. Select
a Process to display the Detail View for that
process.
© Fairsail 2017
117
Glossary
People Bar
Summary
In Fairsail WX, the right panel giving access to
other people in your organization. People Bar
includes People Search and, typically, immediate
links to your manager(s), direct reports, cross
reports, and colleagues.
A type of WX Process providing high level
reporting and summary information. For
example, the total number of employees in your
organization, all Team Members with birthdays in
the next 7 days, or all new hires joining your
organization in the last 7 days.
Select a person in the People Bar to display their
Services in the Service Bar.
Pixel, px
Picture element. The smallest addressable
element in a display, so its physical dimensions
depend on the display device. A commonly used
unit when defining the dimensions of images,
tables, and so on. A valid unit to use in CSS.
In Fairsail WX, each Tile is a panel in the main
display window used to show top level
information for a WX Process. Select a Service
from the Navigation Bar or the Service Bar to
show all the Tiles for that Service. Most Tiles
include a View Details link to the Detail View.
WX Process
Recognition
A type of WX Process enabling you to use social
performance management within your
organization. Team members use Recognition to
provide immediate positive feedback to others
on tasks, events, or actions that demonstrate
core values or competencies. Feedback takes the
form of a Recognition award recorded on the
system and visible to Team Members through
WX.
Also known as Shout Outs, Badging,
Crowdsourced Performance Review.
Service Bar
In Fairsail WX the area beneath the banner giving
access to Services. When using Fairsail WX to
display your own information, the Service Bar
displays tabs for your Services with menu options
for your Processes. When using Fairsail WX to
display information about another person, the
Service Bar displays tabs and menu options for
their Services and Processes.
Select a Service to display summary information
in Tiles for all the Processes in that Service. Select
a Process to display the Detail View for that
process.
Fairsail WX Configuration Guide
Tile View
A group of features that deliver a part of Fairsail
WX functionality, such as Objectives,
Performance Review, or Skills. You group WX
Processes into WX Services, and a Process can
appear in more than one Service. You can name
both WX Processes and WX Services to match the
needs of your organization.
WX Processes are displayed to Team Members
through the WX Navigation Bar and Service Bar;
selecting a WX Process displays the Detail view
for the Process. As an HR Manager or
Administrator you can access WX Processes
through the hosting WX Services - use the WX
Services tab. Each WX Process has one or more
options in a Policy that enables the Process to be
configured.
WX Service
A group of WX Processes. For example, a
Performance Management Service with
component Processes for Objectives,
Recognition, and Performance Review. You can
name both WX Processes and WX Services to
match the needs of your organization.
WX Services are displayed to Team Members
through the WX Navigation Bar and Service Bar;
selecting a WX Service displays Tiles for the
component Processes. As an HR Manager or
Administrator you can access WX Services
through the WX Services tab.
© Fairsail 2017
118
Index
A
About this Guide - 6
Adding a Language to Your Org - 105, 108
Adding and Amending the Language Selector
Picklist - 110
Adding HR Notices to WX Pages - 37, 41
Adding Local Language Versions - 9, 48, 49
Adding the HR Noticeboard Related List - 37, 40,
41
Adding WX Fields to HR Noticeboard Page Layout
- 37, 38, 41
Authorizing Manager - 117
F
Fairsail HCM
Guide for HR Managers - 6
Fairsail HCM Configuration Guide - 6
Fairsail Processes in this WX Release - 11, 15
Fairsail WX
Guide for Users - 7
Feedback - 7
Field Level Security - 21
Field Sets
Payslips - 78, 79
Recognition - 65
B
Badge - 117
Browser Compatibility - 14
G
Guidelines for Team Member Pictures - 104
C
Changing the Appearance of Your WX - 98
Changing the Default Language - 105, 111
Checking and Adding Available Languages - 105,
106, 108, 109
Creating a New Internal Communication - 43, 45,
49, 55
Creating a New Internal Communication from a
WX Process - 29, 52
Creating a New WX Process - 27, 43, 52, 55, 58,
63, 66, 70, 78, 82
Creating a New WX Service - 25
Custom Object permissions - 21
D
Detail View - 117
E
Embedding Social Feeds in WX - 43, 59
Enabling Data Display and Configuring Tile
Content - 70, 74
H
Hiring Manager - 87, 117
How to Add a Supported Language - 105
How to Change the Base Color - 23, 92, 102
How to Change the Fairsail Logo - 92, 100
How to Change the Fairsail WX Title - 99
How to Ensure Service and Process Names can be
Translated - 31, 35, 105
How to Optimize WX Performance - 93
How to Set Up a Summary Process - 9, 66
How to Set Up and Use Internal Communications
- 9, 43
How to Set Up and Use WX Services - 8, 22, 24
How to Set Up Compensation Planning - 82
How to Set Up Delegated Access for Assistants 83
How to Set Up Non-HCM Processes - 6, 84
How to Set Up Payslips - 78
How to Set Up Recognition - 9, 63
How to Set Up Year End Vacation Balance
Reporting - 9, 69
How to Use HR Noticeboard with WX - 37, 41
HR Manager Portal Tabs for WX - 22
I
Internal Communications - 117
Internal Portal - 117
Internal Recruitment - 85
Introduction - 8
L
Locale Codes - 50, 112
Fairsail WX Configuration Guide
© Fairsail 2017
119
Index
M
Maintaining Translations in WX - 35
Modify Existing Internal Communications - 16, 20
Modify Page Layout
Existing WX Services - 16, 17
No Existing WX Services - 16, 19
Modify Profile Settings - 16, 21
Moving End Users From Collaboration Portal To
WX - 15
Moving from Fairsail Collaboration Portal to WX 7
My Applications - 117
N
Navigation Bar - 117
U
Upgrading to the Latest WX Release - 10, 16
Using Confirmation for WX Internal
Communications - 58
Using Scoring for WX Internal Communications 9, 48, 55
V
Viewing and Editing Payslip Data through the HR
Manager Portal - 78, 80
Visualforce pages - 21
W
WX Options on the HCM Configure Page - 92
WX Process - 118
WX Service - 118
P
People Bar - 118
Picklists
Internal Communication - 60
Pixel, px - 118
Policy Options
Async Reporting - 23, 70, 73
Internal Communications - 23, 43, 44
Payslips - 23, 78, 79
Recognition - 23, 63, 64
Summary - 23, 66, 68
Policy Options for Fairsail WX - 23
R
Recognition - 118
Related Guides - 6
Relevant Field Sets - 85, 87, 88
Running a Batch Immediately - 72
S
Service Bar - 118
Setting up a Batch to Update Report Data - 70, 71
Speeding Up WX After Initial Page Loading - 92,
93, 95
Speeding Up WX Initial Page Loading - 92, 93, 94
Summary - 118
T
Tile View - 118
Translation Workbench
Async Reporting - 75
Internal Communication - 61
Recognition - 65
Summary Process - 68
Wx Base Colour Setup - 103
WX Process - 36
WX Service - 36
Fairsail WX Configuration Guide
© Fairsail 2017
120