Scribd
Upload
830 views15 pages

Fusion Time Clock Device Integration v1.0

This document outlines the REST API specification for integrating an external time collection device with the Oracle Fusion Workforce Management product. The API allows sending time event data as JSON payloads in batches. Validated time events will be saved to the time repository, and can then be used to generate employee time cards within Oracle Fusion. A proof of concept integration with a hypothetical TESCO time collection device is proposed to demonstrate usage of the API.

Uploaded by

Abxabx Baxbax
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
830 views15 pages

Fusion Time Clock Device Integration v1.0

This document outlines the REST API specification for integrating an external time collection device with the Oracle Fusion Workforce Management product. The API allows sending time event data as JSON payloads in batches. Validated time events will be saved to the time repository, and can then be used to generate employee time cards within Oracle Fusion. A proof of concept integration with a hypothetical TESCO time collection device is proposed to demonstrate usage of the API.

Uploaded by

Abxabx Baxbax
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 15

FusionTime Clock Device

REST ServiceIntegration
Abhishek Satti
Issue 1.0

Table of Contents
1.

Introduction .......................................................................................................................................... 3

2.

Expected Outcomes .............................................................................................................................. 4

3.

Assumptions .......................................................................................................................................... 5

4.

REST API Specification ........................................................................................................................... 6

5.

4.1

URI ................................................................................................................................................. 6

4.2

List of Fields................................................................................................................................... 6

Proof Of Concept for TESCO.................................................................................................................. 9

1. Introduction
This document outlines the time event service exposed by the Oracle Fusion Workforce Management
product. This service sends events which will be saved in the time repository collection devices. The
type of event supported in the initial release are swipes made at time (TcD) such as reporting to work,
leaving for meal break, and ending the work shift.
The expectation is that SOA middle-ware will send information to the time event service. The
information will be sent in batches. Events will then be received in groups.

2. Expected Outcomes
Once the time event is received by the workforce management system it is lightly validated and verified.
Time event received by workforce management will be validated and verified. Erroneous resources will
be returned in error status else they will be saved to time events data model. Time events will then be
reviewed and/or corrected by admin.
Valid time events are saved in time repository. Generate time cards from Time Collection devices will
convert time events into time entries similar to those entered via Oracle Fusion Time & Labor Interface.

3. Assumptions
1. The time events received will be time entries meant for the Time & Labor layer and stored as
Reported Time structure.
2. At this time there are no requirements to receive schedule information from the time event service
interface.
3. Nor is there an expectation that the time events will be calculated results.

4. REST API Specification


4.1 URI
/hcmWorkforceMgmtApi/resources/latest/timeEventRequests/
Example: https:/xxxxtest.hcm.em3.oraclecloud.com/hcmWorkforceMgmtApi/resources/latest/timeEventRequests/

4.2 List of Fields

Field
Name

Size

Requ
ired

Sourc
e

Sample
Value

Description

"11235813"

The request identifier is provided by the


TCD vendor. Combination of
requestNumber and sourceId must be
unique. This identifier enables detecting
multiple submissions of the same request. It
is also required to support the management
of asynchronous responses. Can be a GUID,
number, or any other format as determined
by the TCD vendor.

Maintai
ned in
Fusion.
To be
sent by
TcD.

"Tesco"

The source creating the data. This could be


a vendor name or a facility identifier.
Source must be first entered into the Fusion
system by customer prior to being used. A
request is unique within the context of the
source. Can be a GUID, number, or any
other format as determined by the TCD
vendor.

SOA

"2014-0928T01:02:3
9.00001:00"

The date and time at which the request was


created

timeEventRe
quests:

requestNum
ber

sourceId

requestTime
stamp

String(
80)

String(
120)

Timest
amp

SOA

timeEvents:

deviceId

eventDateTi
me

supplierDevi
ceEvent

reporterId

reporterIdTy
pe

String(
40)

Timest
amp

String(
40)

String(
80)

String(
30)

Maintai
ned in
Fusion.
To be
sent by
Tcd

"100"

The identifier of the device used to create


the time event.

TcD

"2014-0928T01:01:4
1.00001:00"

The punch/swipe time

Maintai
ned in
Fusion .
To be
derived
from
TcD

"PUNCH_IN
"

The type of time event as managed by the


TCD solution client/vendor (e.g.
ShiftPunchIn). Must be entered into Oracle
Fusion Workforce Management prior to use

Maintai
ned in
Fusion .
To be
derived
from
TcD

The reporter identifier type.


Enumeration :
BADGE
PERSON

Constan
t.
Depend
s on
configu "BADGE"/"P
ration
ERSON"

Maintai
ned in
Fusion.
To be

The name of the attribute which provides


additional information about the time
event. This must be an attribute recognized
in the Oracle Fusion Workforce

The identifier of the worker. Corresponds


with the reporterIdType. Valid Values:
1. Person Number
2. Person Number
"4011"

3. Assignment ID

ASSIGNMENT

timeEventAt
tributes:

name

String(
240)

"Payroll
Time Type"

derived
from
TcD

value

String(
150)

Maintai
ned in
Fusion.
To be
derived
from
TcD

Management system.

"Regular"

The value of the named attribute.

5. Proof Of Concept for TESCO

1. Setup user in HCM Cloud:


-Add role Time and Labor Administrator to User in OIM

Add Policies for Entitlement HWM_REST_SERVICE_ACCESS_TIME_EVENTS_PRIV


Open the Policies for Entitlement:

Add TCD user to Principals in the policy added above.(If the policy is not added create one as
below and add a Principal)

Now this user has access to call REST Time events


2. Create a SOAP Project. Test the access to RESTful service with following endpoint and
resource:
Create New REST Project:

Endpoint: https://crn.hcm.em2.oraclecloud.com
Resource: /hcmWorkforceMgmtApi/resources/latest/timeEventRequests
Authentication: X
Media type: application/vnd.oracle.adf.resourceitem+json
Run Post Method with empty payload to check response

3. Create Payload for an Employee:


{"sourceId":"TNT","requestNumber":"1200220337","requestTimestamp":"2016-07-22T08:00:00.00008:00","timeEvents":[{"reporterIdType":"PERSON","supplierDeviceEvent":"TNT_IN","eventDateTime":"20
16-07-22T08:00:00.000-08:00","reporterId":"440005","deviceId":"100"}]}
{"sourceId":"TNT","requestNumber":"1200220338","requestTimestamp":"2016-07-22T08:00:00.00008:00","timeEvents":[{"reporterIdType":"PERSON","supplierDeviceEvent":"TNT_OUT","eventDateTime":"
2016-07-22T18:00:00.000-08:00","reporterId":"440005","deviceId":"100"}]}

Legend for payload:

Sourceid: Device Supplier Code

supplierDeviceEvent: Define Supplier Device Event

requestNumber: A unique number(to be generated by Source/SOA)


reporterId: Person Number in HCM Cloud
deviceID: Source ID from Manage Time Device Processing Profile task

4. Run the payload in SOAP UI and Check the response:

5. Verify if the Time events have been created in UI:


Go to My Workforce->Time Management -> Manage Time events
Key in Person Number and search:

6. Generate time card from Time Collection Devices:


Go to task Define Time Device Configuration under Setup and Maintenance:

Submit the process

After Process is completed Go to Time Management Again and verify if time is entered correctly:

Go to Manage time cards

Time is verified:

You might also like