Вы находитесь на странице: 1из 15

Loading Checklist Templates and Allocated Checklists

Using HCM Data Loader

Oracle Fusion Human Capital Management 11g Release 9 (11.1.9)


ORACLE WHITE PAPER | MAY 2015
Table of Contents

Loading Checklist Templates and Allocated Checklists Using HCM Data Loader 0
Introduction 1
How to Use the Information in This Document 1
Checklist Templates 2
Considerations and Prerequisites for Checklist Templates 2
Checklist Category 2
Checklist Name and Checklist Category 2
Checklist Task Name 2
Checklist Template Translation Objects 2
Conditional Prerequisites 2
Loading Checklist Templates 3
Checklist Template Component 3
Checklist Task Component 4
Checklist Template Errors 6
Deletion Support for Checklist Templates 6
Checklist Template Translation 6
Checklist Task Translation 7
Allocated Checklists 8
Considerations and Prerequisites for Allocated Checklists 8
Loading Allocated Checklists 8
Allocated Checklist 8
Allocated Checklist Task 9
Allocated Checklist Errors 12
Deletion Support for Allocated Checklists 12

LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Introduction
Whether implementing Oracle Fusion Global Human Resources for the first time or providing regular
updates, you can create checklist template and allocated checklist records using HCM Data Loader.

For general information about preparing data for loading using HCM Data Loader or the HCM Data
Loader file format, see the HCM Data Loader User’s Guide (MOS Doc ID: 1664133.1).

How to Use the Information in This Document


This document provides a separate section for each business object that it describes. Each section
covers the following topics:

 Considerations and Prerequisites What to consider before attempting to load data.


 Loading Describes the business object hierarchy. For each business object component, a table of
the attributes that are commonly supplied when creating new records is provided. These tables
have the following columns:

 HCM Data Loader Attribute The attribute name to supply when providing your data in the
business object data (.dat) file. Attribute names with a *1 suffix are foreign-object references
that support the integration key types. As source keys are recommended where possible, the
document describes how to supply source key values. User key attributes are identified for
when you do not have the source key value.
 User Interface Prompt The prompt seen on the user interface. The data that you supply in
the associated attribute derives this field value, which is not necessarily the same as the value
that you supply. For example, for the Location field on an Organization page you can supply
the Oracle Fusion surrogate ID, source key, or Oracle Fusion GUID to identify the location
uniquely. The value seen on the user interface will be the location name.
If the user interface prompt is prefixed with an asterisk (*), then the attribute is mandatory
when you create a new record.
 Functional Description Additional information describing the attribute and how to supply
valid values.

 Errors Identifies errors that may occur when loading data for the business object. Information
about resolving the error is provided.
 Deletion Support Describes the extent to which the business object supports data deletion. Some
objects do not support deletion, while others may support deletion of child records only.
 Translation Information on how to provide translation data for the translatable attributes in the
business object hierarchy.

1 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Checklist Templates
Use checklist templates for actions that require the completion of standard tasks, such as creating users or
reassigning resources. For example, employee hire and termination actions typically require a number of people to
complete standard tasks. You create and maintain tasks within a checklist template. You can create checklist
templates that can be allocated to persons either automatically or manually. Create checklists using the Manage
Checklist Templates task in the Setup and Maintenance work area.

Using HCM Data Loader, you can create both a checklist and the tasks within the checklist. For example, you can
create a new hire template with tasks for system access and badge issue.

Considerations and Prerequisites for Checklist Templates

Checklist Category
Checklist category must be available in the system before checklist templates can be loaded using HCM Data
Loader. These two checklist categories are available by default, but you can add your own to suit business needs:

 On Boarding
 Off Boarding

Checklist Name and Checklist Category


The combination of checklist name and checklist category must be unique.

Checklist Task Name


The checklist task name must be unique for a checklist.

Checklist Template Translation Objects


You cannot delete translation objects in isolation; you can only correct or update them. When you delete the base
object, the corresponding translation records are also deleted.

Conditional Prerequisites
While defining checklist templates, if you plan to use actions, responsibility types, or eligibility profiles, then you must
ensure that the following requirements are met.

Actions
If you plan to use actions in the checklist template, then actions must be available in the system before you can load
checklist templates using HCM Data Loader. Multiple actions are available by default, but you can add your own to
suit business needs. Available actions include:

 New Hire
 Transfer

Responsibility Types
If you plan to use responsibility types in the checklist template, then responsibility types must be available in the
system before you can load checklist templates using HCM Data Loader. These four responsibility types are
available by default, but you can add your own to suit business needs:

 Benefits Representative
 Human Resources Representative

2 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
 Payroll Representative
 Union Representative

Eligibility Profiles
If you plan to use eligibility profiles in the checklist template, then eligibility profiles must be available in the system
before you can load checklist templates using HCM Data Loader.

Loading Checklist Templates


Checklist template data must be supplied in the checklist.dat file for processing by HCM Data Loader.

CHECKLIST TEMPLATE HIERARCHY

Component Functional Description Discriminator

Checklist Template Use checklist templates for actions that require the completion of standard tasks for a Checklist
person. A checklist template can be allocated to persons either manually or
automatically when persons experience the action associated with the checklist
template.

Checklist Task Task is a part of the checklist template and can be assigned to a performer. ChecklistTask

Checklist Template Component


The discriminator Checklist is used to load checklist template records using HCM Data Loader. The following
Checklist attributes are commonly supplied when loading a new checklist template.

CHECKLIST TEMPLATE COMPONENT

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes ChecklistName and ChecklistCategory.

ChecklistName * Name Unique checklist name. This name can be translated. See the Checklist Template
Translation section on page 6.

ChecklistCategory * Category The category of checklist for which the checklist is being created. The value is
validated using the CHECKLIST_CATEGORY lookup.

ActionCode Action Name The action code associated with the checklist template record. You can supply
either the code for the action or the name in the ActionName attribute.
An indicative list of valid values is:
 HIRE - Hire an Employee
 HIRE_ADD_WORK_RELATION - Add Employee Work Relationship
 REHIRE - Rehire an Employee
 PROMOTION - Promotion
 TRANSFER - Transfer
 GLB_TRANSFER - Global Transfer

ActionName Action Name The action name associated with the checklist template record. An indicative list of
valid values is:
 Hire
 Add Employee Work Relationship

3 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
HCM Data Loader
User Interface Prompt Functional Description
Attribute

 Rehire an Employee
 Promotion
 Transfer
 Global Transfer

Description Description Description of the checklist. This description can be translated. See the Checklist
Template Translation section on page 6.

Figure 1: Manage Checklist Templates


Navigation: Setup and Maintenance - Manage Checklist Template - Create Checklist Template

Checklist Task Component


The discriminator ChecklistTask is used to load checklist-template task records using HCM Data Loader. The
following attributes must be supplied when loading:

CHECKLIST TASK COMPONENT

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes ChecklistName and ChecklistCategory.

ChecklistId*1 * Name / Category The checklist template for which this task is provided. If using user keys, supply
the ChecklistName and ChecklistCategory attributes.
If you supplied a source key for the checklist template record, then supply the
same SourceSystemId value here and add the source key hint to this attribute
name, that is, ChecklistId(SourceSystemId).

ChecklistTaskName * Name Name of the Checklist Template Task. This name can be translated. See the
Checklist Task Translation section on page 7.

Description Description Description of the checklist task. This description can be translated. See the
Checklist Task Translation section on page 7.

MandatoryFlag * Required An indication of whether a particular task is required. Valid values are Y (Yes) and
N (No)

4 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
HCM Data Loader
User Interface Prompt Functional Description
Attribute

TargetDuration Target Duration Target duration of the checklist task to be completed.

TargetDurationUOM Target Duration UOM Unit of measure for the duration of the checklist task to be completed. Valid values
are D (Days), W (Weeks), M (Months), and null. This attribute is validated using
the CHECKLIST_QUALIFYING_UNITS lookup.

EligibilityProfileName Eligibility Profile Name of the eligibility profile.

ActionURL Action URL Action URL of checklist template task. This value can be translated. See the
Checklist Task Translation section on page 7.

ResponsibilityType Performer Identifies the area of responsibility (AoR) or other roles responsible for performing
the task. This attribute is validated using the PER_RESPONSIBILITY_TYPES
lookup.
In addition to AoR roles, you can also specify Line Manager, Worker, or Initiator
using these values:
 ORA_LN_MGR (Line Manager)
 ORA_WORKER (Worker)
 ORA_INITIATOR (Initiator)
The line manager is the default performer whenever the performer is not provided
or is invalid.

User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference

ChecklistName Name Name of the checklist. Required if no other key type is supplied to reference the
checklist template.

ChecklistCategory Category Category of the checklist. Required if no other key type is supplied to reference the
checklist template. This attribute is validated using the CHECKLIST_CATEGORY
lookup.

*1 The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and
user key. The value supplied will derive the value seen in the field specified in the User Interface Prompt.

Figure 2: Create Task


Navigation: Setup and Maintenance - Manage Checklist Template - Create Checklist Template - Create Task

5 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Checklist Template Errors
You may experience errors while loading checklist templates if the data is not provided as expected. Some of the
more commonly occurring errors are:

Error Message: The New Hire value is not valid for the ActionId attribute.

Resolution: Verify that the value provided for Action Code or Action Name is valid.

Error Message: The responsibility does not exist.

Resolution: Verify that the value provided in Responsibility Type is valid.

Error Message: The eligibility profile ID is invalid.

Resolution: Verify that the value provided in Eligibility Profile is valid and applicable for Checklist Usage and
Participant Profile.

Deletion Support for Checklist Templates


You can delete checklist templates using HCM Data Loader.

Note: You cannot recover records that you delete using HCM Data Loader.

Do not supply DELETE instructions in the same file as MERGE instructions.

You cannot delete translation objects in isolation; you can only correct or update them. When you delete the base
object, the corresponding translation records are also deleted.

Checklist Template Translation


The checklist template name and description can be translated. The ChecklistTranslation.dat file is used to
provide translation data after the checklist template has been created.

The discriminator ChecklistTranslation is used to load translation records using HCM Data Loader. The following
checklist template translation attributes are available when loading a new translation:

LOCATION TRANSLATION ATTRIBUTES

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / n/a You must provide a unique reference for the record being translated. Supply either
SourceSystemOwner the source key used when creating your data or the user key attributes
ChecklistName and ChecklistCategory.

Name * Name The translated value for the checklist template name.

Description Description The translated value for the checklist template description.

Language * not displayed The language of the supplied translated value. For example, FR, DE.

User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference

ChecklistName Name Name of the checklist. Required if no other key type is supplied to reference the
checklist template.

6 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
HCM Data Loader
User Interface Prompt Functional Description
Attribute

ChecklistCategory Category Category of the checklist. Required if no other key type is supplied to reference the
checklist template. This attribute is validated using the CHECKLIST_CATEGORY
lookup.

Checklist Task Translation


The checklist task name, description, and action URL can be translated. The ChecklistTaskTranslation.dat file is
used to provide translation data after the checklist template task has been created.

The discriminator ChecklistTaskTranslation is used to load translation records using HCM Data Loader. The
following checklist task template translation attributes are available when loading a new translation:

CHECKLIST TEMPLATE TASK COMPONENT

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes ChecklistName, ChecklistCategory, and
ChecklistTaskName.

TaskName * Name Translated name of the checklist template task in the language specified.

Description Description Translated description of the checklist template task in the language specified.

ActionURL Action URL Translated action URL of the checklist template task in the language specified.

Language * not displayed The code for the language into which the contents of the translatable columns are
translated.

User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference

ChecklistName Checklist Name Name of the checklist. Required if no other key type is supplied to reference the
checklist template task.

ChecklistCategory Checklist Category Category of the checklist. Required if no other key type is supplied to reference the
checklist template task. This attribute is validated using the
CHECKLIST_CATEGORY lookup.

ChecklistTaskName Task Name Name of the checklist task. Required if no other key type is supplied to reference
the checklist template task.

7 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Allocated Checklists
Allocated checklists are those that have been allocated to workers and contain the tasks relevant to them. You can
allocate checklists to persons either automatically or manually. You can manually allocate a checklist using the
Manage Allocated Checklists task in the Person Management work area.

Using HCM Data Loader, you can allocate a checklist to a person. For example, you can allocate a new hire
checklist with tasks for system access and badge issue to a person.

Considerations and Prerequisites for Allocated Checklists


Both the checklist template and the workers must exist before you start allocating checklists to workers.

Loading Allocated Checklists


Allocated checklist data must be supplied in the AllocateChecklist.dat file for processing by HCM Data Loader.

ALLOCATED CHECKLIST HIERARCHY

Component Functional Description Discriminator

Allocated Checklist A checklist template that has been allocated to one or more workers and contains only AllocateChecklist
tasks that are relevant to those workers.

Allocated Checklist Task that is a part of the allocated checklist and that can be assigned to one or more AllocateChecklistTask
Task performers.

Allocated Checklist

The discriminator AllocateChecklist is used to load allocated checklist records using HCM Data Loader. The
following AllocateChecklist attributes are commonly supplied when loading a new allocated checklist.

ALLOCATE CHECKLIST COMPONENT

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes PersonNumber, ChecklistName,
ChecklistCategory, and ChecklistInstance.

PersonId*1 * Person Number A unique reference to the person the checklist is for. If using user keys, supply the
PersonNumber attribute.
If you supplied a source key for the person record, then supply the same
SourceSystemId value here and add the source key hint to this attribute name,
that is, PersonId(SourceSystemId).

ChecklistName * Name Name of the checklist that is to be created and allocated to a worker.

ChecklistCategory * Category Category of the checklist that is to be created and allocated to a worker. The value
is validated using the CHECKLIST_CATEGORY lookup.

8 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Description Description Description of the checklist that is allocated to a worker.

ChecklistStatus Checklist Status The value is validated using the PER_CHECKLIST_TASK_STATUS lookup.

ChecklistInstance * Instance Checklist instance.

A unique reference to the template checklist. If using user keys, supply the
attributes TemplateChecklistName, TemplateChecklistCategory, and
TemplateLegislationCode.
If you supplied a source key for the checklist template record, then supply the
same SourceSystemId value here and add the source key hint to this attribute
*1
ChecklistId name, that is, ChecklistId(SourceSystemId).

User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference

PersonNumber Person Number Person number of the person to whom the checklist is allocated. Required if no
other key type is supplied to reference the person.

TemplateChecklistNa Name Name of the template checklist that is to be allocated to an individual.


me

TemplateChecklistCat Category Category of the template checklist that is to be allocated to an individual.


egory

AllowAutoAllocation * not displayed An indication of whether tasks in the checklist template should be allocated
automatically. Valid values are Y (Yes) and N (No).

*1 The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key and
user key. The value supplied will derive the value seen in the field specified in the User Interface Prompt.

Figure 3: Create and Allocate Checklist


Navigation: Person Management - Manage Allocated Checklists - Create and Allocate Checklist

Allocated Checklist Task


The allocated checklist task holds details of the tasks.

The discriminator AllocateChecklistTask is used to load allocated checklist task records using HCM Data Loader.
The following attributes are commonly supplied when loading:

ALLOCATE CHECKLIST TASK COMPONENT

HCM Data Loader


User Interface Prompt Functional Description
Attribute

SourceSystemId / You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes PersonNumber, ChecklistName,
ChecklistCategory, ChecklistInstance, and TaskName.

9 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
HCM Data Loader
User Interface Prompt Functional Description
Attribute

AllocatedChecklistId*1 * Person Number / Name / The checklist this task is for. If using user keys, supply the attributes
Category / Instance PersonNumber, ChecklistName, ChecklistCategory, and ChecklistInstance.
If you supplied a source key for the checklist template record, then supply the
same SourceSystemId value here and add the source key hint to this attribute
name, that is, AllocatedChecklistId(SourceSystemId).
*1
PersonId * Person Number A unique reference to the person the checklist is for. If using user keys supply the
attribute PersonNumber.
If you supplied a source key for the person record, then supply the same
SourceSystemId value here and add the source key hint to this attribute name,
that is, PersonId(SourceSystemId).

TaskName * Name A task is a job that one performs upon some request. For example, Issuing No
Dues Certificate, Taking Exit Interview, Generating E-Mail Account, Allocating a
Parking Lot, and so on.

Description Description Description of the task that is allocated to a worker.

MandatoryFlag * Required An indication of whether a particular task is required. Valid values are Y (Yes) and
N (No).

Status Status Status of the task that is allocated to a worker. The value is validated using the
PER_CHECKLIST_TASK_STATUS lookup.

TargetStartDate * Target Start Date Target start date of the task that is allocated to a worker.

TargetEndDate Target End Date Target end date of the task that is allocated to a worker.

ActualStartDate * Actual Start Date Actual start date of the task that is allocated to a worker.

ActualEndDate Actual End Date Actual end date of the task that is allocated to a worker.

ActionURL Action URL Action URL for the task that is allocated to a worker.

TaskOwnerPersonId Owner A unique reference to the person who is the task owner. If using user keys, supply
the attribute TaskOwnerPersonNumber.
If you supplied a source key for the owner person record, supply the same
SourceSystemId value here and add the source key hint to this attribute name,
that is, TaskOwnerPersonId(SourceSystemId).

ResponsibilityType Performer Identifies the responsibility of the person performing the task. This attribute is
validated using the PER_RESPONSIBILITY_TYPES lookup. Valid values are
 ORA_LN_MGR (Line Manager)
 ORA_WORKER (Worker)

TaskPerformerPersonI Performer A unique reference to the person who is the task performer. If using user keys,
d *1 then supply the attribute TaskPerformerPersonNumber.
If you supplied a source key for the performer person record, then supply the same
SourceSystemId value here and add the source key hint to this attribute name,
that is, TaskPerformerPersonId (SourceSystemId).

User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference

PersonNumber Person Number Person number of the person to whom the checklist is allocated. Required if no
other key type is supplied to reference the person.

ChecklistName Name Name of the checklist this task is for. Required if no other key type is supplied to
reference the checklist.

ChecklistCategory Category Category of the checklist that this task is for. Required if no other key type is
supplied to reference the checklist.

10 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
HCM Data Loader
User Interface Prompt Functional Description
Attribute

The value is validated using the CHECKLIST_CATEGORY lookup.

ChecklistInstance Instance Instance of the checklist that this task is for. Required if no other key type is
supplied to reference the checklist.

TaskOwnerPersonNu Owner Checklist task owner person number. Required if you are supplying a task owner
mber and no other key type has been supplied to reference the task owner.

TaskPerformerPerson Performer Checklist task performer number. Required if you are supplying a task performer
Number and no other key type has been supplied to reference the task performer.

*1 The foreign object references support use of all four key types: Oracle Fusion Surrogate ID, Oracle Fusion GUID, source key,
and user key. The value supplied will derive the value seen in the field specified in the User Interface Prompt

Figure 4: Create Task


Navigation: Person Management - Manage Allocated Checklists - Create and Allocate Checklist - Create Task

Figure 5: Manage Allocated Checklists


Navigation: Person Management - Manage Allocated Checklists

11 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Allocated Checklist Errors
You may experience errors while loading allocated checklists if the data is not provided as expected. Some of the
more commonly occurring errors are:

ALLOCATED CHECKLIST ERRORS

Error Resolution

Attribute PersonId is required. Check that a valid performer or owner exists in the system. If you are
using responsibility types, then verify that active contacts exist for
the responsibility types. If you are using person numbers, then verify
that they are active.

Deletion Support for Allocated Checklists


You can delete Allocated Checklists using HCM Data Loader.

Note: You cannot recover records that you delete using HCM Data Loader.

Do not supply DELETE instructions in the same file as MERGE instructions.

12 | LOADING CHECKLIST TEMPLATES AND ALLOCATED CHECKLISTS USING HCM DATA LOADER
Oracle Corporation, World Headquarters Worldwide Inquiries
500 Oracle Parkway Phone: +1.650.506.7000
Redwood Shores, CA 94065, USA Fax: +1.650.506.7200

CONNECT W ITH US

blogs.oracle.com/oracle Copyright © 2014, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the
contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other
warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
facebook.com/oracle fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are
formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any
twitter.com/oracle means, electronic or mechanical, for any purpose, without our prior written permission.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
oracle.com
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0515

Loading Checklist Templates and Allocated Checklists using HCM Data Loader
May 2015