Service Optimization
ClickRoster Shift
Preferences
Product ClickApp by ClickSoftware
For use with ClickMobile Touch
ClickSoftware Confidential
Legal Notice
The software with this guide is furnished under a license agreement and may be used only according to
the terms of that agreement.
Copyright
Copyright © ClickSoftware Technologies Ltd. All rights reserved.
No part of this publication may be copied without the express written permission of ClickSoftware
Technologies Ltd..
Patent and Trademark
US Patent Number 6,985,872 B2
ClickAnalyze, ClickFix, ClickForecast, ClickMobile, ClickPlan, ClickRoster, ClickSchedule, and
ClickSoftware are registered trademarks of ClickSoftware Technologies Ltd.
Contact Information
Contact information is available from the ClickSoftware web site: http://www.clicksoftware.com.
For general information, email to [email protected].
For ClickSoftware Worldwide Support, email to [email protected] or see the support page on
the ClickSoftware web site.
For Partner Enablement, email to [email protected].
Publication Notice
This guide has been carefully compiled. The information in this guide does not constitute a warranty of
performance. Furthermore, ClickSoftware reserves the right to revise this publication and make changes
from time to time in the content thereof, without obligation to notify any person of such revisions or
changes. ClickSoftware assumes no liability for losses incurred as a result of out-of-date or incorrect
information in this guide.
Version
ClickRoster Shift Preferences
Date: July 13, 2017
ClickRoster Shift Preferences
3
Contents
SHIFT PREFERENCES .................................. 4
Use ............................................................................................................. 4
Date Navigation Top Bar ...................................................................... 5
Preferences Bar .................................................................................... 5
Buttons Bar ........................................................................................... 5
Shift List View ....................................................................................... 5
Shift Monthly View ................................................................................ 6
Prerequisites .............................................................................................. 6
Installation .................................................................................................. 6
Configuration .............................................................................................. 7
Service Optimization Structure ............................................................. 7
Service Optimization Administration ..................................................... 7
System Events .................................................................................... 10
SXP Exposing ..................................................................................... 11
Mobility Studio .................................................................................... 13
Shift Preferences Settings .................................................................. 18
Comments ................................................................................................ 20
4
ClickRoster Shift Preferences
Shift Preferences
The ClickRoster Shift Preference app allows a win-win situation between the
organization and employee. The app takes into account the organizational rules and
constraints. Also, as much as possible, it considers the employee preferences,
without violating the organizational rules.
Use
The application is implemented as a business view (with an alternative user
interface), and contains the following modules:
ClickRoster Shift Preferences
5
Date Navigation Top Bar
Located at the top of each view, this bar allows you to quickly switch between dates.
It includes the following elements :
Date String - Displays the currently selected date.
Today button - Switch to today's date.
Left arrow button - Switch the date one element (month) back.
Right arrow button - Switch the date one element (month) forward.
Preferences Bar
Located just below the Top Bar, this bar allows you to set the preference selection
mode.
After this mode is set, it is applied to each clicked time slot.
The following modes are allowed:
Prefer - Interested in working that shift.
Prefer Not - Not interested in working that shift
No Preference - Don't have an opinion on whether or not to work that shift.
Buttons Bar
The Buttons bar is a general purpose buttons container.
It is located at the bottom of the screen and contains the following elements:
Refresh button
List View button - Switches to the Shifts List view.
Monthly View button - Switches to the Shifts Monthly view.
Left and Right Arrow buttons - Switches between tabs.
Shift List View
This view lists time slots which represent future shifts.
The view is split into two panes. The left pane lists all the days of the selected
month, and the right pane lists the available time slots for each day.
Each time slot is highlighted by type: Prefer, Prefer Not or No Preference.
6
ClickRoster Shift Preferences
After selecting the Preference mode from the Preference Bar, clicking on a time slot
will change its type to the selected mode.
Shift Monthly View
Displays a calendar like representation of the selected month. Each cell of the
calendar represents a single day and contains the following information:
Day Number
Short day name
Time Slots indicators
Each cell is colored according to the type of day and shift availability for that day:
Previous / Next Month
Regular work days
Weekend days
Clicking a day that belongs to the current month opens the List view of that date.
Clicking a day that belongs to the previous or next month, will move the calendar to
that month.
Prerequisites
This app runs on the ClickMobile Touch client.
The app is currently certified for use in ClickMobile 8.1.7, with Patch 4 or higher
installed. For potentially updated information about certification in other
ClickMobile versions and clients, contact ClickSoftware.
Installation
1.
2.
On each computer where you run the Mobility Studio, copy the following file to
the Service Optimization\Bin directory:
CAF.BusinessView.Roster.MyPreferences.Admin.dll
On each computer where you run the ClickMobile Touch site, copy the
following files to the Service
Optimization\Web\ClickMobileWeb\CustomScripts directory:
CAF.View.Roster.Preferences.min.js
ClickRoster Shift Preferences
CAF.View.Roster.Preferences.Resources.js
CAF.View.Roster.Preferences.css
CAF.View.Roster.Loading.gif
CAF.View.Preference.RadioBtn.png
CAF.View.Preference.RadioBtnChecked.png
Configuration
To configure the application follow these instructions.
Service Optimization Structure
1.
2.
3.
4.
5.
Lock the server.
In the RosterResourcePreference business object add the following :
New property MobileKey (String, 64).
New index RosterResourcePreference_MobileKey (add
MobileKey from Object Properties to the Indexed Properties).
Commit the changes.
In the Engineer business object add the following:
New property MobileKey (String, 64).
New index Engineer_MobileKey (add MobileKey from "Object
Properties" to the Indexed Properties).
Commit the changes.
Unlock the server
Service Optimization Administration
Loading Criteria
Open Central Settings/ClickMobile /General Settings
Under the General Loading Criteria tab, add a loading criteria for the following
business objects:
RosterResourcePreference
Under Using Groups  Query for object of type Engineer add Key  equals 
Parameter 1
Under RosterResourcePreferences Group  Query for object of type
RosterResourcePreference add RelatedResource  equals  Parameter 1
7
8
ClickRoster Shift Preferences
Click Next , drag the Key from the left column and the RelatedResource from the
right column to the central linking form.
Load data from today up to two months forward.
ClickRoster Shift Preferences
9
10
ClickRoster Shift Preferences
Engineer
Under Using Groups  Query for object of type Engineer add Key  equals 
Parameter 1
Under Engineers Group  Query for object of type Engineer add Key  equals 
Parameter 1
Click Next, drag and drop the Key from the left column and the Key from the right
column to the central linking form .
If you want to login with a different engineer, add him to the loading criteria.
System Events
In the Service Optimization Administration tool: Open Central Settings  Parameters
 Events  System Events
Double-click EventSystem  Body XML
Expand the EventSystem  Right click on Collections and Paste the following XML:
<Item CollectionID="30000102">
<ClassID Type="COM" Active="true">
W6CMServer.W6CMGenericObjectEvent, W6CMServer
ClickRoster Shift Preferences
11
</ClassID>
</Item>
SXP Exposing
In order to expose SXP via Service Optimization Remote Administration  Central
Settings  Integration&Services  Web Services & SXP Messages  Message
Settings, perform the following:
1. Add a new Web Operation  Next
Web Service - RosterService
Web Operation - GetResourceShiftPreferencesInfo
Check Expose the web operation also as SXP Message
SXP Name - SXPGetResourceShiftPreferencesInfo
2. Click Next
3. Check Enable Integration
4. Click Add  Next  Finish
5. Close Service Optimization Remote Administration.
12
ClickRoster Shift Preferences
ClickRoster Shift Preferences
13
Mobility Studio
1. In the Mobility Studio, edit the ClickMobile Touch user template.
2. From the toolbox, drag a business view to the views area of the template.
3. Choose RosterResourcePreference object and enter the following values:
Display Name - Shift Preferences
Display Type - Custom
Choose a keyword for the following properties:
Short Description – any combination such as Start Time FinishTime
Title Description - any combination such as Start Time FinishTime
Sort & Search – any property such as StartTime (Ascending)
4.
5.
In order to improve the user experience , it is advised to disable the alerts under
Properties  Alerts .
In Object Form Definition, from the RosterResourcePreference Fields tab - add:
RelatedResource
Start Time
14
ClickRoster Shift Preferences
Finish Time
PreferenceMode
ContentType
6.
In the Properties tab - Set the MobileKeyPropertyName field to MobileKey
7.
Inner Object Form Definitions:
ClickRoster Shift Preferences
a.
8.
9.
15
Add the Engineer object.
From the Engineer Fields tab, add the Name field to the from.
From the Properties tab, set the MobileKeyPropertyName field to MobileKey.
16
ClickRoster Shift Preferences
Note:
Only when using the application as a standalone, set the
following parameters. Otherwise set these parameters in the
Container App Settings.
Custom Display Type
JS - CAF.View.Roster.Preferences.min.js
Class Name - CAFP.View.Roster.Preferences.Main
Custom Admin Type
ClickRoster Shift Preferences
17
JS - CAF.BusinessView.Roster.MyPreferences.Admin.dll
Class Name CAF.BusinessView.Roster.MyPreferences.Admin.Main
Close the settings tab and reopen it.
Configure the Shifts Preferences Settings by opening the Custom Settings in the
RosterResourcePreference properties.
Note:
Optimization
General
General.
Note:
To ensure a correct functionality of the SXP message
GetRosterResourcePreferences,
open
Service
Administration  Central Settings  ClickRoster 
Settings  Application Settings  ClickRoster 
Uncheck the Support Sites check box.
In versions older than 8.1.8 it's recommended to disable the
Adaptive Split View Otherwise, the application will not be
displayed properly.
Additional Properties
Under the Additional Properties menu, add the following properties:
Note:
Some of the fields might be already in the list
Engineer
Engineer
Engineer
Engineer
–
–
–
–
Key
Name
Latitude
Longitude
18
ClickRoster Shift Preferences
RosterResourcePreference – Key
RosterResourcePreference – Finish Time
RosterResourcePreference – Mobile Key
Apply the settings and close the Mobility Studio.
Shift Preferences Settings
Select weekend days
Choose the colors for the following elements:
Prefer Color
Prefer Not Color
No Preference Color
Orphan Color
ClickRoster Shift Preferences
Non-Working Color
Working Days
Current Day
Prev/Next Month
Display Days Settings
Number of Days to Display
Note: Select lower values for better scrolling performance on slower devices.
Display Days List (Yes or No)
Number of Months to load
Edit the No Time Slots Message
19
20
ClickRoster Shift Preferences
Comments
The ClickMobile appearance is configurable. The layout might differ on your
device.