{"id":14564,"date":"2018-07-10T09:10:58","date_gmt":"2018-07-10T09:10:58","guid":{"rendered":"https:\/\/kb.sambapos.com\/?p=14564"},"modified":"2018-09-24T11:24:59","modified_gmt":"2018-09-24T11:24:59","slug":"4-14-how-to-set-time-clock-implementation","status":"publish","type":"post","link":"https:\/\/kb.sambapos.com\/en\/4-14-how-to-set-time-clock-implementation\/","title":{"rendered":"4.14. How to Set Time Clock Implementation?"},"content":{"rendered":"

Document Index<\/strong><\/span><\/p>\n

1. Adding PunchIn and PunchOut States<\/span><\/p>\n

2. Adding Employee Entities<\/span><\/p>\n

2.1. Adding Employee Entity Type<\/p>\n

2.2. Adding Employee Entities<\/p>\n

3. Adding Time Clock Entity Screen<\/span><\/p>\n

4. Adding Automation Commands<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a04.1. Time<\/span>\u00a0Clock Button \/ Navigation Tile AMC<\/span><\/p>\n

5. Adding Actions<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.1. Show Time Clock Screen Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.2.\u00a0Execute<\/span>\u00a0Automation Command Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.3.\u00a0Show<\/span>\u00a0Message Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.4\u00a0Ask<\/span>\u00a0Question Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.5.\u00a0Load<\/span>\u00a0Entity Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.6.\u00a0Log<\/span>\u00a0Entity State Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.7.\u00a0Update<\/span>\u00a0Entity State Action<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.8.\u00a0Update<\/span>\u00a0Program Setting Action<\/span><\/p>\n

6. Adding Rules<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a06.1.\u00a0Show<\/span>\u00a0Time Clock Screen Rule<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a06.2.\u00a0Load<\/span>\u00a0Entity Rule<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a06.3.\u00a0Time<\/span>\u00a0Clock Punch (Ask) Rule<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a06.4.\u00a0Update<\/span>\u00a0Entity State Rule<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a06.5.\u00a0Log<\/span>\u00a0Entity State Rule<\/span><\/p>\n

7. Adding Reports and Scripts<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a07.1. Adding Reports<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 7.1.1. Hourly Report<\/span><\/p>\n

7.1.2. Report For Employee Nizam<\/p>\n

7.1.3. Report For Employee Veysel<\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a07.2. Adding Scripts<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 7.2.1.\u00a0Employee Hours Daily<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 7.2.2.\u00a0Employee Punch In Latest<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 7.2.3.\u00a0Employee Hours TTL<\/span><\/p>\n

 <\/p>\n

Before Starting to Time Clock Implementation<\/span><\/strong><\/p>\n

In this document, it will be explained how to set Basic Time Tracking System for Employees. This implementation will allow Employee Entities, to Clock In and Clock Out.<\/span><\/p>\n

Before starting Time Clock Implementation process, there are 2 settings to be configured about Navigation Screen Buttons;<\/span><\/p>\n

1- Allowing Custom Navigation Option<\/strong><\/span><\/p>\n

Go to Main Menu > Manage > Settings > Local Settings > Display ><\/strong> In here, select\u00a0Allow Custom Navigation.<\/strong><\/span><\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

2- Creating Default Navigation Buttons<\/strong><\/span><\/p>\n

Go to Main Menu > Settings > Program Settings > Maintenance ><\/strong> In here click on Create Default Navigation Buttons.<\/strong><\/span><\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

View of Time Clock Implementation<\/strong><\/span><\/p>\n

\"\"<\/p>\n

 <\/p>\n

Time Clock Implementation<\/span><\/strong><\/p>\n

1. Adding PunchIn and PunchOut States<\/span><\/strong><\/p>\n

These States are used to track when an Employee is Clocked In or Clocked Out.<\/p>\n

Go to Main Menu > Manage > Settings > States ><\/strong> In here add state for PunchIn by clicking on Add State<\/strong> link. Repeat the same steps for PunchOut state as well.<\/p>\n

\"\"<\/p>\n

Entity State for\u00a0Clocked In<\/code><\/strong>
\nName:<\/strong>\u00a0PunchIn<\/code>
\nState Name:<\/strong>\u00a0TCStatus<\/code>
\nState Type:<\/strong>\u00a0Entity State<\/code><\/p>\n

Entity State for\u00a0Clocked Out<\/code><\/strong>
\nName:\u00a0<\/strong>PunchOut<\/code>
\nState Name:\u00a0<\/strong>TCStatus<\/code>
\nState Type:<\/strong>\u00a0Entity State<\/code><\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

2. Adding Employee Entities<\/span><\/strong><\/p>\n

2.1. Adding Employee Entity Type<\/strong><\/p>\n

Go to Main Menu >Manage > Entities > Entity Types ><\/strong> In here add an entity type by clicking on Add Entity Type<\/strong> link.<\/p>\n

General Settings Section;<\/strong><\/p>\n

\"\"<\/p>\n

Name:\u00a0<\/strong>Employees<\/code>
\nEntity Name: <\/strong>Employee<\/code>
\nPrimary Field Name:\u00a0<\/strong>Name<\/code>
\nDefault States:<\/strong>\u00a0TCStatus=PunchOut;TCReport=Unloaded<\/code><\/p>\n

Version 5 supports\u00a0Default States<\/code><\/strong>\u00a0for Entity Types. This sets a \u201cstarting State\u201d when a new Entity is created. Set the Default States as shown in the image above.<\/p>\n

Custom Fields Section;<\/strong><\/p>\n

\"\"<\/p>\n

Accounting Section; (Optional for Payroll)<\/strong><\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

In order to select Employees Account as account type, you need to create Employees Account Type and Account for Each Employee advance as shown on the images below;<\/p>\n

Adding Employees Account Type<\/strong><\/p>\n

Go to Main Menu > Manage > Accounts > Account Types ><\/strong> In here click on Add Account Type<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name:<\/strong> Employees Accounts<\/p>\n

Filter Type:<\/strong> Month (Select according to your need)<\/p>\n

Rules:<\/strong> Default<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

Adding Account for Each Employee<\/strong><\/p>\n

Go to Main Menu > Manage > Accounts > Accounts ><\/strong> In here click on Add Account<\/strong> link.<\/p>\n

\"\"<\/p>\n

Account Name:<\/strong> Give the name of your employee.<\/p>\n

Account Type:<\/strong> Employees Accounts<\/p>\n

Currency:<\/strong> Blank<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

 <\/p>\n

2.2. Adding Employee Entity<\/strong><\/p>\n

Go to Main Menu > Manage > Entities > Entities ><\/strong> In here click on Add Entity<\/strong> link.<\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

 <\/p>\n

3. Adding Time Clock Entity Screen<\/span><\/strong><\/p>\n

Go to Main Menu > Manage > Entities > Entity Screens ><\/strong> In here click on Add Entity Screen<\/strong> link.<\/p>\n

General Settings Section;<\/strong><\/p>\n

\"\"<\/p>\n

Name:<\/strong>\u00a0Time Clock<\/code><\/p>\n

Ticket Type:<\/strong>\u00a0Ticket<\/code><\/p>\n

View Mode:<\/strong>\u00a0Custom<\/code><\/p>\n

Appearance Section;<\/strong><\/p>\n

\"\"<\/p>\n

Entity List Section;<\/strong><\/p>\n

\"\"<\/p>\n

Entity Type:<\/strong>\u00a0Employees<\/code><\/p>\n

Display State:<\/strong>\u00a0TCStatus<\/code><\/p>\n

State Filter:<\/strong>\u00a0Blank<\/code><\/p>\n

Select the Employee Entities you want to appear on the screen by clicking on Select Entity<\/strong> link.<\/p>\n

Mappings Section;<\/strong><\/p>\n

\"\"<\/p>\n

In mappings section, add a row by clicking on Add<\/strong> link.<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

Design Mode Configurations<\/strong><\/p>\n

It is necessary to create a single\u00a0Entity Grid<\/code><\/strong>\u00a0and several\u00a0Report Viewers<\/code><\/strong>\u00a0(one Report for each Employee) on the Time Clock Entity Screen.<\/p>\n

Entity Grid Widget<\/h3>\n

Entity Grid Properties\u00a0<\/strong><\/p>\n

\"\"<\/p>\n

Entity Grid Settings<\/strong><\/p>\n

\"\"<\/p>\n

Entity Type:<\/strong>\u00a0Employees<\/code>
\nDisplay State:<\/strong>\u00a0TCStatus<\/code>
\nAutomation Command:<\/strong>\u00a0TC-Load Entity<\/code>
\nCommand Value:<\/strong>\u00a0{ENTITY NAME}<\/code><\/p>\n

Report Viewer Widgets<\/h3>\n

Report Viewer Properties; Employee Nizam<\/strong><\/p>\n

\"\"<\/p>\n

Name:\u00a0Hours Nizam<\/code><\/p>\n

Report Viewer Settings; Employee Nizam<\/strong><\/p>\n

\"\"<\/p>\n

Report Name:\u00a0Employee Hours<\/code>
\nParameters:\u00a0Employee,Nizam<\/code><\/p>\n

Report Viewer Properties; Employee Veysel<\/strong><\/p>\n

\"\"<\/p>\n

Name:\u00a0Hours Veysel<\/code><\/p>\n

Report Viewer Settings; Employee Veysel<\/strong><\/p>\n

\"\"<\/p>\n

Report Name:\u00a0Employee Hours<\/code>
\nParameters:\u00a0Employee,Veysel<\/code><\/p>\n

4. Adding Automation Commands<\/strong><\/span><\/p>\n

4.1. Time<\/span>\u00a0Clock Button \/ Navigation Tile AMC<\/span><\/strong><\/p>\n

Go to Main Menu > Manage > Automations > Automation Commands ><\/strong> in here click on Add Automation Command<\/strong> link.<\/p>\n

Genereal Settings Section;<\/strong><\/p>\n

\"\"<\/p>\n

Name:<\/strong>\u00a0TC-Show Timeclock<\/p>\n

Category:<\/strong> Navigation<\/p>\n

Button Header:<\/strong> Time Clock<\/p>\n

Color:<\/strong>\u00a0DarkBlue<\/p>\n

Font Size:<\/strong>\u00a040<\/p>\n

Confirmation:<\/strong> None<\/p>\n

Clear Selection:<\/strong> Select this box.<\/p>\n

Navigation Settings Section;<\/strong><\/p>\n

\"\"<\/p>\n

Navigation Module:<\/strong> Entity<\/p>\n

Navigation Parameter:<\/strong> Time Clock<\/p>\n

Navigation Tile Template:<\/strong><\/p>\n

\n\n\n\n
[People:1<\/span>]<\/code><\/span><\/p>\n

<size 44<\/span>><bold<\/span>><\/span>Time Clock<\/bold<\/span>><\/span><\/span><\/size<\/span>><\/span><\/span>
\n<\/code><\/span><\/p>\n

@Nizam,Veysel<\/code><\/span><\/p>\n

[='{SETTING:TCStatus $1}'<\/span>=='Clocked In'<\/span> ? '$1 ::: '<\/span> + '{ENTITY STATE MINUTES BY NAME:Employees.$1:TCStatus}'<\/span> : ''<\/span>]<\/code><\/span><\/p>\n

 <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Mappings Section;<\/strong><\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/span><\/span><\/p>\n

 <\/p>\n

5. Adding Actions<\/strong><\/span><\/p>\n

5.1. Show Time Clock Screen Action<\/strong><\/p>\n

This action is used for refreshing the Time Clock screen.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name:<\/strong>\u00a0 TC-Show Time Clock Screen<\/p>\n

Action Type:<\/strong>\u00a0Navigate Module<\/p>\n

Module Name: <\/strong>Entity<\/p>\n

Parameter:<\/strong>\u00a0Time Clock<\/p>\n

Hide Header:<\/strong>\u00a0True<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.2. Execute Automation Command Action<\/strong><\/p>\n

This action is used for executing other actions.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name: <\/strong>TC-ExecAMC<\/p>\n

Action Type: <\/strong>Execute Automation Command<\/p>\n

Automation Command Name:<\/strong>\u00a0[:AMCname]<\/p>\n

Command Value:<\/strong>(blank)<\/em><\/p>\n

Background:<\/strong>\u00a0False<\/p>\n

Delay:<\/strong>\u00a00<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.3.\u00a0Show\u00a0Message Action<\/strong><\/p>\n

This action is used to show messages.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name:<\/strong> TC-Show Message<\/p>\n

Action Type:<\/strong> Show Message<\/p>\n

Message:<\/strong> [:message]<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.4\u00a0Ask\u00a0Question Action<\/strong><\/p>\n

This action is used to ask the user to\u00a0Clock In<\/strong>\u00a0or\u00a0Clock Out<\/strong>.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name:<\/strong>\u00a0TC-Punch (Ask)<\/p>\n

Action Type:<\/strong>\u00a0Ask Question<\/p>\n

Question:<\/strong> [:Question]<\/p>\n

Buttons:\u00a0<\/strong> [:Buttons]<\/p>\n

Automation Command Name:<\/strong> [:AMCname]<\/p>\n

Background Color:<\/strong> [:BGcolor]<\/p>\n

Transparent Color:<\/strong>(blank)<\/em><\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.5.\u00a0Load\u00a0Entity Action<\/strong><\/p>\n

This action is used to load an Employee Entity so that it is possible to read and set the Entity Data and State.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Name:<\/strong> TC-LoadEntityBySearch<\/p>\n

Action Type:<\/strong> Load Entity<\/p>\n

Entity Type Name:<\/strong> [:EntityTypeName]<\/p>\n

Entity Name:<\/strong>(blank)<\/em><\/p>\n

Entity Search Value:<\/strong> [:SearchValue]<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.6. Log Entity State Action<\/strong><\/p>\n

This action is used to log the Employee Entity State as\u00a0PunchIn<\/strong>\u00a0(Clocked In) or\u00a0PunchOut<\/strong>\u00a0(Clocked Out).<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Action Name: <\/strong>TC-LogEntityState\u00a0<\/strong><\/p>\n

Action Type:<\/strong>\u00a0Log Entity State<\/p>\n

Name:\u00a0<\/strong>[:logName]<\/p>\n

Entity Id:\u00a0<\/strong>[:entityId]<\/p>\n

State Name:\u00a0<\/strong>[:SGroupName]<\/p>\n

Start State:<\/strong>\u00a0[:StateBeg]<\/p>\n

Start State Date:\u00a0<\/strong>[:SDateBeg]<\/p>\n

End State:\u00a0<\/strong>[:StateEnd]<\/p>\n

End State Date:\u00a0<\/strong>[:SDateEnd]<\/p>\n

Custom Data:\u00a0<\/strong>[:SCustomData]<\/p>\n

Async:\u00a0<\/strong>[:Async]<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.7. Update Entity State Action<\/strong><\/p>\n

This action is used to set the Employee Entity State to\u00a0PunchIn<\/strong>\u00a0or\u00a0PunchOut<\/strong>.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Action Name:<\/strong>\u00a0TC-Update Entity State<\/p>\n

Action Type:<\/strong>\u00a0Update Entity State<\/p>\n

Entity Type Name:<\/strong> Employees<\/p>\n

Entity State Name:<\/strong>\u00a0TCStatus<\/p>\n

Entity State:<\/strong> [:NewState]<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

5.8.\u00a0Update\u00a0Program Setting Action<\/strong><\/p>\n

This action is necessary to update various Program Settings used to track certain parameters.<\/p>\n

Go to Main Menu > Manage > Automation > Actions ><\/strong> in here click on Add Action<\/strong> link.<\/p>\n

\"\"<\/p>\n

Action Name:<\/strong>\u00a0TC-Update Program Setting<\/p>\n

Action Type:\u00a0<\/strong>Update Program Setting<\/p>\n

Setting Name:<\/strong>\u00a0[:SettingName]<\/p>\n

Setting Value:<\/strong>\u00a0[:SettingValue]<\/p>\n

Update Type:<\/strong> Update<\/p>\n

Is Local:<\/strong> False<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n<\/div>\n

 <\/p>\n

6. Adding Rules<\/strong><\/span><\/p>\n

6.1. Show Time Clock Screen Rule<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Rules ><\/strong> in here click on Add Rule<\/strong> link.<\/p>\n

\"\"<\/p>\n

Rule Name:<\/strong>\u00a0TC-Show Time Clock Screen<\/p>\n

Event Name:<\/strong> Automation Command Executed<\/p>\n

Execute Rule if:<\/strong> Matches<\/p>\n

Add Custom Constraints:\u00a0<\/strong>Automation Command Name | Equals |\u00a0TC-Show Timeclock<\/p>\n

Action:<\/strong>\u00a0TC-Show Time Clock Screen<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

6.2.\u00a0Load<\/span>\u00a0Entity Rule<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Rules ><\/strong> in here click on Add Rule<\/strong> link.<\/p>\n

\"\"<\/p>\n

Rule Name:<\/strong> TC-Load Employee Entity<\/p>\n

Event Name:<\/strong> Automation Command Executed<\/p>\n

Execute Rule if:<\/strong> Matches<\/p>\n

Add Custom Constraints:\u00a0<\/strong>Automation Command Name | Equals |\u00a0TC-Load Entity<\/p>\n

Action:<\/strong>\u00a0TC-LoadEntityBySearch<\/p>\n

Entity Type Name:<\/strong> Employees<\/p>\n

Search Value:<\/strong> [:CommandValue]<\/p>\n

Action:<\/strong>\u00a0TC-ExecAMC<\/p>\n

Constraint:<\/strong>\u00a0Blank<\/p>\n

AMCname:<\/strong>\u00a0TC-Punch<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

6.3.\u00a0Time Clock Punch (Ask) Rule<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Rules ><\/strong> in here click on Add Rule<\/strong> link.<\/p>\n

\"\"<\/p>\n

Rule Name:<\/strong> TC-Time Clock Punch (Ask)<\/p>\n

Event Name:<\/strong> Automation Command Executed<\/p>\n

Execute Rule if:<\/strong> Matches<\/p>\n

Add Custom Constraints:\u00a0<\/strong>Automation Command Name | Equals |\u00a0TC-Punch<\/p>\n

Action:<\/strong>\u00a0TC-Punch (Ask)<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

Question:\u00a0<\/strong>Select a TimeClock Action for {ENTITY NAME}:<\/p>\n

Buttons:<\/strong>\u00a0\u00a0Clock In=PunchIn:Orange;Gray,Clock Out=PunchOut:White;Gray,Cancel=Cancel:Red;Gray<\/p>\n

AMCname:<\/strong> TC-Update Entity State<\/p>\n

BGColor:<\/strong>\u00a0DarkBlue<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

6.4.\u00a0Update<\/span>\u00a0Entity State Rule<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Rules ><\/strong> in here click on Add Rule<\/strong> link.<\/p>\n

\"\"<\/p>\n

\"\"<\/p>\n

Rule Name:<\/strong> TC-Update Entity State<\/p>\n

Event Name:<\/strong> Automation Command Executed<\/p>\n

Execute Rule if: Matches All<\/em><\/strong><\/p>\n

Add Custom Constraints:\u00a0<\/strong><\/p>\n

Automation Command Name | Equals |\u00a0TC-Update Entity State<\/p>\n

Command Value | Not Equals | Cancel<\/p>\n

Command Value | Not Equals |\u00a0{ENTITY STATE:TCStatus}<\/p>\n

Action:<\/strong>\u00a0TC-Update Entity State<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

NewState: <\/strong>[:CommandValue]<\/p>\n

Action:<\/strong>\u00a0TC-Update Program Setting<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

SettingName:\u00a0<\/strong>TCStatus {ENTITY NAME}<\/p>\n

SettingValue:<\/strong>\u00a0[=('[:CommandValue]'=='PunchIn' ? 'Clocked In' : 'Clocked Out')]<\/code><\/p>\n

Action: <\/strong>TC-ExecAMC<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

AMCname: <\/strong>TC-Show Timeclock<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

6.5. Log<\/span>\u00a0Entity State Rule<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Rules ><\/strong> in here click on Add Rule<\/strong> link.<\/p>\n

\"\"<\/p>\n

Rule Name:<\/strong> TC-Log Entity State<\/p>\n

Event Name:<\/strong>\u00a0Entity State Updated<\/p>\n

Execute Rule if:<\/strong> Matches<\/p>\n

Add Custom Constraints:\u00a0<\/strong><\/p>\n

Entity Type Name | Equals |\u00a0Employees<\/p>\n

State Name | Equals |\u00a0TCStatus<\/p>\n

State | Not Equals |\u00a0Cancel<\/p>\n

Action:<\/strong>\u00a0TC-LogEntityState<\/p>\n

Constraint:<\/strong> Blank<\/p>\n

logName: <\/strong>Time Clock<\/p>\n

entityId: <\/strong>[:EntityId]<\/p>\n

SGroupName:\u00a0<\/strong>[:StateName]<\/p>\n

StateBeg:<\/strong> [:StartState]<\/p>\n

SDateBeg: <\/strong>[:StartStateDate]<\/p>\n

StateEnd:<\/strong>\u00a0[:EndState]<\/p>\n

SDateEnd:\u00a0<\/strong>[:EndStateDate]<\/p>\n

SCustomData:<\/strong>\u00a0ManualPunch~{SETTING:HolidayFlag}<\/p>\n

Async:<\/strong>\u00a0False<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7. Adding Reports and Scripts<\/strong><\/span><\/p>\n

7.1. Adding Reports<\/span><\/strong><\/p>\n

7.1.1. Adding Hourly Report<\/strong><\/span><\/p>\n

Go to Main Menu > Manage > Reports > Reports ><\/strong> in here click on Add Report<\/strong> link.<\/p>\n

\"\"<\/p>\n

Copy and paste below code group into template area;<\/p>\n\n\n\n
[Current Hours $2:10,21,21,9]
\n@@EmployeePunchInLatest:$1,$2<\/code>[Previous Hours $2:10,21,21,9]<\/code>>Employee|Start|End|Hours
\n@@EmployeeHoursDaily:$1,$2<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/code><\/p>\n

The $ variables<\/code>\u00a0in the Report are passed from the Report Viewer Widget Parameter list. The Parameters are assigned as follows:<\/strong><\/p>\n\n\n\n
$1 : Entity Type (Employee)<\/p>\n

$2 : Employee Name (i.e. Nizam\u00a0or<\/span>\u00a0Veysel\u00a0or<\/span> …)<\/p>\n

$3 : Date Filter Start (optional)<\/p>\n

$4 : Date Filter End (optional)<\/p>\n

$5 : unused<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

In the report template area, you need to replace $1 value with Employee, and $2 value with Employee Name. After that the report will be seen like in the image below.<\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7.1.2. Adding Report For Employee Nizam<\/strong><\/p>\n

Go to Main Menu > Manage > Reports > Reports ><\/strong> in here click on Add Report<\/strong> link.<\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7.1.3. Adding Report For Employee Veysel<\/strong><\/p>\n

Go to Main Menu > Manage > Reports > Reports ><\/strong> in here click on Add Report<\/strong> link.<\/p>\n

\"\"<\/p>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7.2. Adding Scripts<\/span><\/strong><\/p>\n

The SQL Scripts are called from within the Report shown above.<\/p>\n

7.2.1.\u00a0Employee Hours Daily<\/span><\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Scripts ><\/strong> in here click on Add Script<\/strong> link.<\/p>\n

\"\"<\/p>\n

Script Name:<\/strong>\u00a0EmployeeHoursDaily<\/p>\n

Handler:<\/strong>\u00a0@@EmployeeHoursDaily<\/p>\n

Script: <\/strong>Copy and paste below code group into script field;<\/p>\n\n\n\n
-- PARM for Employee Entity Type
\ndeclare @EntityType varchar(20) = '@1'
\n-- PARM for Employee Name
\ndeclare @Employee varchar(20) = '@2'
\n-- PARM for Date Filter Start
\ndeclare @StartDateIn varchar(25) = '@3'
\n-- PARM for Date Filter End
\ndeclare @EndDateIn varchar(25) = '@4'<\/code>
\n-- if Employee Entity Type is invalid, set default as 'Employee'
\nIF (@EntityType = '') OR (@EntityType is null) OR (@EntityType = '$1') SET @EntityType = 'Employee'<\/code><\/code><\/code>-- if Date Filter START is invalid, set default to beginning of Current Month
\nIF (@StartDateIn = '') OR (@StartDateIn is null) OR (@StartDateIn = '$3') SET @StartDateIn = left(CONVERT(VARCHAR(25), GETDATE(), 126),7)+'-01T00:00:00'<\/code><\/code><\/code>-- if Date Filter END is invalid, set a default
\nIF (@EndDateIn = '') OR (@EndDateIn is null) OR (@EndDateIn = '$4') SET @EndDateIn = dateadd(Month,1,@StartDateIn)<\/code><\/code><\/code>-- set START and END date for Report Period
\ndeclare @StartDate datetime = convert(varchar(25),@StartDateIn,126)
\ndeclare @EndDate datetime = convert(varchar(25),@EndDateIn,126)
\ndeclare @EndDateInc datetime = convert(varchar(25),dateadd(day,-1,@EndDate),126)<\/code><\/code><\/code>-- set name of HolidayFlag
\ndeclare @HolidayFlag varchar(20) = 'Holiday'<\/code>
\n-- set name of Clock-In State
\ndeclare @Clockin varchar(20) = 'PunchIn'<\/code>
\n-- set Overtime Hour Limit
\ndeclare @HourLimit decimal(4,2) = 8.00<\/code><\/code><\/code>-- NOTHING TO SET BEYOND HERE)<\/code><\/code><\/code>SELECT<\/code><\/code><\/code>e.Name,StartStateDate,EndStateDate,CONVERT(VARCHAR(8),(EndStateDate-StartStateDate),108) as TotalHours<\/code><\/code><\/code>FROM [EntityStateLogs] sl
\nleft join [Entities] e on e.[Id]=sl.[EntityId]
\nleft join [EntityTypes] et on et.[Id]=e.[EntityTypeId]
\nWHERE 1=1
\nand sl.[StartStateDate] >= '{Start}'
\nand sl.[EndStateDate] <= '{End}'
\nand et.[EntityName] = @EntityType
\nand sl.[StartState] = @Clockin
\nand e.[Name]=@Employee<\/code><\/code><\/code><\/code><\/code><\/code><\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7.2.2. EmployeePunchInLatest<\/span><\/strong>\u00a0<\/span><\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Scripts ><\/strong> in here click on Add Script<\/strong> link.<\/p>\n

\"\"<\/p>\n

Script Name:<\/strong> EmployeePunchInLatest<\/span><\/p>\n

Handler:<\/strong>\u00a0@@EmployeePunchInLatest<\/span><\/p>\n

Script: <\/strong>Copy and paste below code group into script field;<\/p>\n\n\n\n
-- PARM for Employee Entity Type
\ndeclare\u00a0@EntityType\u00a0varchar(20)\u00a0\u00a0=\u00a0'@1'
\n-- PARM for Employee Name
\ndeclare\u00a0@Employee\u00a0varchar(20)\u00a0\u00a0\u00a0\u00a0=\u00a0'@2'
\n-- PARM for Date Filter Start
\ndeclare\u00a0@StartDateIn\u00a0varchar(25)\u00a0=\u00a0'@3'
\n-- PARM for Date Filter End
\ndeclare\u00a0@EndDateIn\u00a0varchar(25)\u00a0\u00a0\u00a0=\u00a0'@4'<\/code>-- if Employee Entity Type is invalid, set default as 'Employee'
\nIF\u00a0(@EntityType =\u00a0'')\u00a0OR\u00a0(@EntityType\u00a0is\u00a0null)\u00a0OR\u00a0(@EntityType =\u00a0'$1')\u00a0SET\u00a0@EntityType =\u00a0'Employee'<\/code>-- if Date Filter START is invalid, set default to beginning of Current Month
\nIF\u00a0(@StartDateIn =\u00a0'')\u00a0OR\u00a0(@StartDateIn\u00a0is\u00a0null)\u00a0OR\u00a0(@StartDateIn =\u00a0'$3')\u00a0SET\u00a0@StartDateIn = left(CONVERT(VARCHAR(25),\u00a0GETDATE(),\u00a0126),7)+'-01T00:00:00'<\/code>-- if Date Filter END is invalid, set a default
\nIF\u00a0(@EndDateIn =\u00a0'')\u00a0OR\u00a0(@EndDateIn\u00a0is\u00a0null)\u00a0OR\u00a0(@EndDateIn =\u00a0'$4')\u00a0SET\u00a0@EndDateIn\u00a0\u00a0= dateadd(Month,1,@StartDateIn)<\/code>-- set START and END date for Report Period
\ndeclare\u00a0@StartDate datetime = convert(varchar(25),@StartDateIn,126)
\ndeclare\u00a0@EndDate datetime = convert(varchar(25),@EndDateIn,126)
\ndeclare\u00a0@EndDateInc datetime = convert(varchar(25),dateadd(day,-1,@EndDate),126)<\/code>-- set name of HolidayFlag
\ndeclare\u00a0@HolidayFlag\u00a0varchar(20)\u00a0=\u00a0'Holiday'<\/code>
\n-- set name of Clock-In State
\ndeclare\u00a0@Clockin\u00a0varchar(20)\u00a0=\u00a0'PunchIn'<\/code>
\n-- set Overtime Hour Limit
\ndeclare\u00a0@HourLimit\u00a0decimal(4,2)\u00a0= 8.00<\/code><\/p>\n

-- NOTHING TO SET BEYOND HERE
\ndeclare\u00a0@Now datetime = CONVERT(VARCHAR(25),\u00a0GETDATE(),\u00a0126)<\/code><\/p>\n

SELECT<\/code>
\ne.Name,StartStateDate,EndStateDate,CONVERT(VARCHAR(5),(EndStateDate-StartStateDate),108)\u00a0as\u00a0TotalHours<\/code><\/p>\n

FROM\u00a0[EntityStateLogs]\u00a0sl
\nleft join\u00a0[Entities]\u00a0e\u00a0on\u00a0e.[Id]=sl.[EntityId]
\nleft join\u00a0[EntityTypes]\u00a0et\u00a0on\u00a0et.[Id]=e.[EntityTypeId]
\nWHERE\u00a01=1
\nand\u00a0sl.[Id]=(select\u00a0max([Id])\u00a0from\u00a0[EntityStateLogs]\u00a0where\u00a0[EntityId]=sl.[EntityId]\u00a0and\u00a0[EndState]=@Clockin)
\nand\u00a0[EndStateDate]>(select\u00a0max([StartStateDate])\u00a0from\u00a0[EntityStateLogs]\u00a0where\u00a0[EntityId]=sl.[EntityId]\u00a0and\u00a0[StartState]=@Clockin)
\nand\u00a0sl.[StartStateDate]\u00a0>= @StartDate\u00a0-- something wrong here
\nand\u00a0sl.[EndStateDate]\u00a0\u00a0\u00a0<\u00a0\u00a0@EndDate
\nand\u00a0et.[EntityName]\u00a0\u00a0\u00a0\u00a0\u00a0=\u00a0\u00a0@EntityType
\nand\u00a0sl.[EndState]\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0=\u00a0\u00a0@Clockin
\nand\u00a0e.[Name]=@Employee
\nORDER\u00a0BY\u00a0e.[Name],\u00a0sl.[StartStateDate]<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n

 <\/p>\n

7.2.3.<\/strong>\u00a0EmployeeHoursTTL<\/strong><\/p>\n

Go to Main Menu > Manage > Automation > Scripts ><\/strong> in here click on Add Script<\/strong> link.<\/p>\n

\"\"<\/p>\n

Script Name:<\/strong> EmployeeHoursTTL<\/p>\n

Handler:<\/strong>\u00a0@@EmployeeHoursTTL<\/p>\n

Script: <\/strong>Copy and paste below code group into script field;<\/p>\n\n\n\n
SELECT
\nsum(\u00a0DATEPART(SECOND,\u00a0EntityStateLogs.EndStateDate-EntityStateLogs.StartStateDate)\u00a0+\u00a060\u00a0*
\nDATEPART(MINUTE,\u00a0EntityStateLogs.EndStateDate-EntityStateLogs.StartStateDate)\u00a0+\u00a03600\u00a0*
\nDATEPART(HOUR,\u00a0EntityStateLogs.EndStateDate-EntityStateLogs.StartStateDate)
\n)\u00a0as\u00a0'TotalHours'
\nFROM\u00a0\u00a0\u00a0EntityStateLogs INNER JOIN Entities
\nON\u00a0EntityStateLogs.EntityId = Entities.Id\u00a0where\u00a0Entities.Name=@Employee\u00a0and\u00a0StartStateDate>='{Start}'\u00a0and\u00a0EndStateDate<='{End}'\/<\/code><\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

After completing necessary editings, click on Save<\/strong> button.<\/p>\n","protected":false},"excerpt":{"rendered":"

Document Index 1. Adding PunchIn and PunchOut States 2. Adding Employee Entities 2.1. Adding Employee Entity Type 2.2. Adding Employee Entities 3. Adding Time Clock Entity Screen 4. Adding Automation Commands \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a04.1. Time\u00a0Clock Button \/ Navigation Tile AMC 5. Adding Actions \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a05.1. Show Time Clock […]<\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7],"tags":[],"class_list":["post-14564","post","type-post","status-publish","format-standard","hentry","category-customization"],"_links":{"self":[{"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/posts\/14564","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/comments?post=14564"}],"version-history":[{"count":109,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/posts\/14564\/revisions"}],"predecessor-version":[{"id":16284,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/posts\/14564\/revisions\/16284"}],"wp:attachment":[{"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/media?parent=14564"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/categories?post=14564"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kb.sambapos.com\/en\/wp-json\/wp\/v2\/tags?post=14564"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}