Service Optimization
Butler – Clock In/Out
Reminder
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
Clock In/Out Reminder
Date: July 29, 2017
Butler – Clock In/Out Reminder
3
Contents
CONTENTS ................................................ 3
BUTLER – CLOCK IN/OUT REMINDER .............. 4
Use ............................................................................................................. 4
Property Changed Butler Event ............................................................ 5
Timer Butler Event ................................................................................ 6
Clock In/Out Reminder ......................................................................... 6
Prerequisites .............................................................................................. 8
Installation .................................................................................................. 8
Configuration .............................................................................................. 8
Property Change Event ........................................................................ 8
Timer Event........................................................................................... 9
Clock In/Out Reminder ....................................................................... 10
Comments ................................................................................................ 12
4
Butler – Clock In/Out Reminder
Butler – Clock In/Out Reminder
This app is used to remind an engineer to clock-in or clock-out if he forgot to do so.
Use
The app analyzes the engineer task status updates, or the current time, according to
the following cases:

Alert an engineer to clock in if he has not yet done so in any of the following
situations:
- If the first task's status is changed to any of the active statuses (for example.
On-Site).
- If the current time is beyond the start time of first task.

Alert an engineer to clock out if he has not yet done so in any of the following
situations:
Butler – Clock In/Out Reminder
5
- If last task's status is any of the closed statuses (for example. Completed),
and a pre-configured time interval has passed.
- If the current time is beyond the finish time of the last task, and a preconfigured time interval has passed.
The application works with two different butler events.

Property Changed Event is used when the engineer needs to be
reminded to clock-in or clock-out after a task status changes.

Timer Event is used to initiate a recurrent sequence that notifies the
engineer to clock-in or clock-out, based on his task schedule.
In these scenarios, the timer event will check whether the engineer has clocked-in or
clocked-out every 30 minutes, and a property event will trigger a reminder if the task
status is change to Completed.
Note:
The following instructions illustrate a possible usage
scenario. The system implementer can configure the app
in many ways. For more information about the
options, see the Configuration section.
Property Changed Butler Event
In order to trigger the Clock In/Out Butler, the event is configured with the
following parameters:
1. Choose Task from Object drop-down
2. Choose Status from Property drop-down
3. Choose Completed from Expected Value drop-down
4. Choose Form Saved from Trigger drop-down
Setting this configuration means that whenever an engineer changes a task status to
Completed and saves the form, the event triggers an action.
6
Butler – Clock In/Out Reminder
Timer Butler Event
In order to trigger the Clock In/Out Reminder Butler, the Timer event should be
configured with the following parameters settings:
Timer Type - Recurring
Time Setting - Hours: 0
Time Setting - Minutes : 30
Clock In/Out Reminder
Configure the following parameters:
Active Tasks
Selected tasks statuses are considered as Active Tasks, such as On-Site.
Butler – Clock In/Out Reminder
Closed Tasks
Selected tasks statuses are considered as Closed Tasks, such as Completed.
Pre-defined Interval
The time interval after the last task finishes until a reminder to clock out is
issued.
Clock In Notification Message
The clock-in reminder message, such as Please do not forget to
clock in
Clock Out Notification Message
The clock-out reminder message, such as Please do not forget to
clock
out
7
8
Butler – Clock In/Out Reminder
Prerequisites
This app runs on the ClickMobile Touch client.
The app is currently certified for use in ClickMobile 8.1.7, with Patch 3 or higher
installed. For potentially updated information about certification in other
ClickMobile versions and clients, contact ClickSoftware.
You should installed and configured the following components before running the
app:

Mobile Butlers Manager

Property Changed Event

Timer Event
1.
On each computer where you run the Mobility Studio, copy the following files
to the Service Optimization\Bin directory:
CAF.Butler.Event.PropertyChanged.Admin.dll
CAF.Butler.Event.Timer.Admin.dll
CAF.Butler.Action.ClockInOutReminder.Admin.dll
On each computer where you run the ClickMobile Touch site, copy the
following files to Service
Optimization\Web\ClickMobileWeb\CustomScripts directory:
CAF.Butler.Event.PropertyChanged.min.js
CAF.Butler.Timer.Event.min.js
CAF.Butler.Action.ClockInOutReminder.min.js
Installation
2.
Configuration
The following are Butler configuration instructions.
Property Change Event
Service Optimization Administration
1. Open the list of dictionaries
2. Open MobileButlerEvent items
Butler – Clock In/Out Reminder
9
3. Create a new item and enter the following values in the properties:
Name
PropertyChanged
ClassType
CAFP.Butler.Event.PropertyChanged
AdminId
CAF.Butler.Event.PropertyChanged.Admin.dll
AdminClassType
CAF.Butler.Event.PropertyChanged.Admin
Property Changed Event Settings
Object - Contains a complete list of available business objects.
Property - After selecting an object, this drop-down list is filled with all the object's
properties.
Expected Value - After selecting a specific property, this field enables the user to
enter the value to be monitored. The type of field (textbox, drop-down etc.) can
change, based on the property type.
Trigger - For each monitored property a triggering mode can be set to:
Form Saved - The action triggered when the user saves the form
Property Changed - The action is immediately triggered after the user changes
the value, before the form is saved.
Timer Event
Service Optimization Administration
1. Open the list of dictionaries.
2. Open the MobileButlerEvent items
3. Create a new item and enter the following values in the properties:
Name
Timer
ClassType
10
Butler – Clock In/Out Reminder
CAFP.Butler.Event.Timer
AdminId
CAF.Butler.Event.Timer.Admin.dll
AdminClassType
CAF.Butler.Event.Timer.Admin
Timer Event Settings
A timer event initiates an action based on its schedule.
Timer Type
Recurring - will execute the action every X hours or minutes
Daily Recurring – will execute the action every day at a specified time.
Hours
Number of hours
Minutes
Number of minutes
Clock In/Out Reminder
Service Optimization Administration
1. Open the list of dictionaries
2. Add a new item named ClockInOutReminder to the ButlerType
dictionary.
3. Add a new item to the MobileButlerAction dictionary, and configure it’s
properties as following:
Name
ClockInOutReminder
ClassType
CAFP.Butler.Action.ClockInOutReminder.Main
AdminId
CAF.Butler.Action.ClockInOutReminder.Admin.dll
AdminClassType
CAF.Butler.Action.ClockInOutReminder.Admin
Butler – Clock In/Out Reminder
ButlerType
Select the key of the ClockInOutReminder type as it appears in the
ButlerType Dictionary.
Mobility Studio
1.
Inside the Form Editor of the ButlerNotification Business View, add a new
ClockInOutReminder tab.
2.
Add a new Custom Panel and configure its CustomPanelDef Class Path as
follows:

DLL Name: CAF.Butler.Action.ClockInOutReminder.min.js

Class Path: CAFP.Butler.Action.ClockInOutReminder.Panel
3.
Click on a blank space on the main view. From Properties choose
TemplateDef. Choose Show only for the following radio button, and then
check the ClockInOutReminder check box.
11
12
Butler – Clock In/Out Reminder
4.
Apply the changes.
Comments
The ClickMobile appearance is configurable. The layout might differ on your
device.