0% found this document useful (0 votes)
20 views9 pages

Activities Definition Import

Uploaded by

MULTIPLE ANGLES
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
0% found this document useful (0 votes)
20 views9 pages

Activities Definition Import

Uploaded by

MULTIPLE ANGLES
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/ 9

Activities Definition Import

Description
The Activities Definition Import integration is used to configure Activities definitions in UKG Dimensions, from a flat file
source. This integration is typically used to create and update the Activity definitions that describe the type of
project/work the employee will charge time against. An Activity definition may consist of 1 to 4 levels. Example: Work
Order / Operation / Task.
Options to enable Employee assignment and Data Access using separate source files.
Employees
Employees can be assigned to work on a specific activity. The employee(s) will be assigned using a separate file detailed
below.
Data Access
The Data Access will be assigned using a separate file detailed below.
Access to an activity can be defined by 4 options (only 1 option may be selected per activity):
• All - no restriction to access the activity
• Generic Jobs - assign a choice of 1 or more Jobs that can access the activity
• Labor Category List - assign 1 list per Labor Category
• Organizational Set - assign 1 Organization Set.

The integration also supports deleting existing Activities in the application based on Activity Combined names provided
in the source file, more details about the source file in ‘File Format’ section.

Source File Specifications


Overview:

Name Value

File Name activities_definition.csv

Format Comma-delimited

Frequency On demand or scheduled

Header Row Yes, 1 row

Source Folder /Inbound

File Layout (Import/Update)


Gray fields denote minimum required fields
1
Import
Dimensions Field Comments / Examples Data Type / Max Length
Field #
Name must not include characters '& _
1 Activity Level 1 Name string 50
* % ? : ; = ( ) / [ ] \ | # @ < >'
2 Activity Level 1 Description string 255
Activity Level 1 Completion Not Started, Incomplete, Complete,
3 String 15
Status Cancelled
Name must not include characters '& _
4 Activity Level 2 Name string 50
* % ? : ; = ( ) / [ ] \ | # @ < >'
5 Activity Level 2 Description string 255
Activity Level 2 Completion Not Started, Incomplete, Complete,
6 String 15
Status Cancelled
Name must not include characters '& _
7 Activity Level 3 Name string 50
* % ? : ; = ( ) / [ ] \ | # @ < >'
8 Activity Level 3 Description string 255
Activity Level 3 Completion Not Started, Incomplete, Complete,
9 String 15
Status Cancelled
Name must not include characters '& _
10 Activity Level 4 Name string 50
* % ? : ; = ( ) / [ ] \ | # @ < >'
11 Activity Level 4 Description string 255
Activity Level 4 Completion Not Started, Incomplete, Complete,
12 String 15
Status Cancelled
13 Scheduled Start Date yyyy-mm-dd Date
14 Scheduled End Date yyyy-mm-dd Date
15 Direct Indirect Indicator Direct = True / Indirect = False String 5
16 Labor Category 1 Value must exist in WFD String 30
17 Labor Category 2 Value must exist in WFD String 30
18 Labor Category 3 Value must exist in WFD String 30
19 Labor Category 4 Value must exist in WFD String 30
20 Labor Category 5 Value must exist in WFD String 30
21 Labor Category 6 Value must exist in WFD String 30
Full organization path including the
22 Location
Job. Value must exist in WFD
23 Cost Center Value must exist in WFD

2
Import
Dimensions Field Comments / Examples Data Type / Max Length
Field #
User Field must not include characters:
24 User Field 1 String 255
'& _ * % ? : ; = ( ) / [ ] \ | # @ < >'.
User Field must not include characters:
25 User Field 2 String 255
'& _ * % ? : ; = ( ) / [ ] \ | # @ < >'.
User Field must not include characters:
26 User Field 3 String 255
'& _ * % ? : ; = ( ) / [ ] \ | # @ < >'.
User Field must not include characters:
27 User Field 4 String 255
'& _ * % ? : ; = ( ) / [ ] \ | # @ < >'.
28 Required Quantity number
29 Standard Hours HH.HH number
30 Standard Quantity number
31 Standard Effective Date yyyy-mm-dd Date
UOM Abbreviated Name. Must exist in
32 Unit of Measure string 3
WFD
33 Customer Short Name Value must exist in WFD string 20
34 Activity Results Template Value must exist in WFD string 50

File Layout – Employees


Grey fields denote minimum required fields

Dimensions
# Comments / Examples Data Type / Max Length
Field
AL1 - 4
Activity Combined
1 AL1 or AL1/AL2 or AL1/AL2/AL3 or String 203
Name
AL1/AL2/AL3/AL4
2 Personnum one per row String 15

Sample – Employees
100/200, 12345
100/200, 12346
100/200, 12347
100/210, 12345
100/210, 12347

File Layout - Data Access

3
Grey fields denote minimum required fields

Data Type / Max


# Dimension Field Comments / Examples
Length
AL1 - 4
Activity Combined
1 AL1 or AL1/AL2 or AL1/AL2/AL3 or String 203
Name
AL1/AL2/AL3/AL4
2 Data Access Type All, Generic Jobs, Labor Category List, Org Set
3 value

Sample - Data Access


100/200, Generic Jobs, Painter
100/200, Generic Jobs, Primer
200/300, Labor Category List, South Plant
300.400, Org Set, Acme Company/US/FL/Maitland/Painter

File Layout (Delete)


Gray fields denote minimum required fields

Import
Dimensions Field Comments / Examples Data Type / Max Length
Field #
1 Activity Combined Name ActivityL1/ActivityL2/ActivityL3 String

2 Activity Id Numeric

Developer Section
CRTs

Remember to update the "CRTConfig" Process properties with any changes to the CRT definitions
or any additional custom tables added.

1.) ActivityDefinition_HeaderCRT

Look Loo Loo Sequ Inclu Inclu Inclu Hol Enab Allo Allo
Exten
up kup kup ence de de de d le w w
d
Key Key Key Valid comp scrap rewo par auto activ activ
comp
1- 2 3 ation leted ped rked ent mati ities ities

4
Activ Meth quant quant quant letion c to be to be
ity od ity in ity in ity in status move start start
Type effici effici effici s ed ed
(Dire encie encie encie befo after
ct s s s re sche
Indir sche dule
ect dule d
Indic d end
ator) start date
date

Direc FA
0=No TRU FALS FALS TRU FAL TRU TRU
t= LS
ne E E E E SE E E
True E

Indir FA
0=No FALS FALS FALS FALS FAL FAL FAL
ect = LS
ne E E E E SE SE SE
False E

2.)ActivityDefinition_ProcessCRT

Column 5 (Allow as default) should be set to FALSE by default.

L A E M M V V R L
L M M
oo ll xc ini ax al al ec a
a in ax
k o lu m im id id ei b
b i i
u w d u u at at ve or
P or m m
p l l A e m m e Req e d Q
r H u u
K o o ct fr du du r uire r Q u
o o m m
ey o o iv o M P ra ra e d e ua a
c ur H H
1 k k it m il ri tio tio q Qua c nt nt
e s o o
- u u y se es o n n ui ntity ei ity it
s Al u ur
A p p t q to ri tr tr r Per v P y
s lo rs s
ct k k o u n t an an e cent e er Al
T ca to to
iv e e b e e y sa sa d age d ce lo
y ti C C
it y y e n cti cti q Ove q nt ca
p o o o
y 2 3 s ce on on u r u ag ti
e n m m
T el v en en a a e o
M pl pl
y e al tr tr n n O n
et et et
pe ct id y y ti ti ve M
h e e
( e at a a ty ty r et
5
Di d io o m m h
re a n d ou ou o
ct s nt nt d
In d all all
di ef o o
re a w w
ct u ed ed
In lt
di
ca
to
r)

0
=
E
0 F F F 0 0 F F
ve
Di = A A A = = A A
n
re R L L L L E L 10 L 10
Al
ct u S S S o ve S S
lo
n E E E w n E E
ca
ti
on

0 F F F 0 0 F F
In
= A A A = = A A
di
R L L L L E L 10 L 10
re
u S S S o ve S S
ct
n E E E w n E E

3.) ActivityDefinition_StatusCRT This CRT is used to translate source status codes to Kronos
status codes (if needed)

Dimensions
Lookup Lookup Lookup
Completion Comments
Key 1 Key 2 Key 3
Status

0 Not Started

1 Incomplete

6
2 Complete

3 Cancelled

Control Properties
Property Parameter Default
Help Text
Name Type Value

Enable
Transaction Boolean true
Assistant

Source Date
Date false yyyy-MM-dd. Example: "MM/dd/yyyy"
Format

Enable
Default is 'False'. If enabled, Standard Hours and Standard
Standard Boolean false
Quantity must be provided.
Hours/Qty

Use Status Default to false, the value will be translated as per Status CRT if
Boolean false
CRT set to true

Editable
Complete Boolean true Default is true, set to false to disable updates
Status

Editable
Required Boolean true Default is true, set to false to disable updates
Quantity

Editable
Completed Boolean true Default is true, set to false to disable updates
Percent

Editable Held
Boolean true Default is true, set to false to disable updates
History

Defaulted to 'Import', Choose 'Add Only' to disqualify updates


Execution to existing Activity and choose 'Update Only' to disqualify new
String Import
Mode Activities from source file. Choose Delete to delete one or
more activities.

7
Property Parameter Default
Help Text
Name Type Value

Employee
Default 'Append', Choose 'Override' to remove all existing
Assignment String Append
assignments and import ones in source file
Action

Data Access
Default 'Append', Choose 'Override' to remove all existing
Assignment String Append
assignments and import ones in source file
Action

Effective
Dated Default 'false', set to true if Effective dated LCEL feature is
Boolean false
Feature enabled in application
Enabled

APIs
API
API Name Type Resource Path Location
Section

Create or _Upsert
Update POST /v1/work/activities/multi_upsert Work
Activities Definition

_Get
Retrieve
POST v1/work/activities/multi_read’ Existing
Activities
Activities

Retrieve
All Labor _Non-
Categories GET v1/commons/labor_categories Dynamic
or by Caches
Name

_Cache
Retrieve
Existing
Base POST /v1/commons/persons/base_persons/multi_read
Person
Person
Numbers

Retrieve
Labor _Retrieve
POST v1/commons/labor_category_lists/apply_read
Category LCELs
Lists

Retrieve _Retrieve
POST v2/commons/labor_category_lists/apply_read
Labor LCELs

8
API
API Name Type Resource Path Location
Section

Category (Effective
Lists Dated)

You might also like