Introduction

Use HCM Spreadsheet Data Loader (HDSL) to provide bulk-data loading capabilities for your business users and inbound integrations. You can configure spreadsheet templates for your specific use cases and assign access to those templates to just the roles that require them. For example, your recruiting integration could have access to a New Hire spreadsheet, whereas the Overtime Hours spreadsheet would be available to your Payroll Administrator.

Designing Templates

You design and test spreadsheet templates on your non-production environments. To do this you grant access to the Spreadsheet Templates task and the ability to load data using HSDL. You then configure which business objects the template designer can import and create templates for, using the Spreadsheet Business Object Access task.

Examples:

The roles required to design and test HSDL templates

Use the Security Console to create the various template designer roles and the Spreadsheet Business Object Access task to configure the business objects and product areas each template designer role can create and import spreadsheet templates for.
  • Task 1 explains how to grant access to the Spreadsheet Business Object Access task.
  • Task 2 explains how to create the template designer roles.
  • Task 3 explains how to configure the business objects and product area a template designer can create and import templates for.

Importing Templates in Production

You'll again use the Spreadsheet Templates task in your production environment to import your tested HSDL templates, assign the roles that can use the template and the access they have, and then activate them. For this you can create various template maintenance roles, configuring the business objects and product areas each role can import templates for.

Examples:

The roles required to assign roles and activate templates

Tip:

It's recommended that the template maintenance role on production doesn't have access to load data using HCM Spreadsheet Data Loader.

You create business object restricted roles on production in a similar way as you do on non-production environments. Alternatively, you can choose to create a single administrator role for importing templates into production, assigning role access and any ongoing maintenance.

Once a template is made active, business object security is replaced by template security and only the role configured to maintain a template can edit it. The advantage of using the administrator role is that you don't need to configure the maintenance role for each of your templates. The disadvantage, you can't restrict the updates users of this role perform. They can edit the template definition, assign, and remove role access and change the status of any template.

Tip:

You can enable auditing of role configuration changes.
  • Task 4 explains how to create production template maintenance roles for a restricted list of business objects.
  • Task 5 explains how to create a template administrator role which can access every template.


Spreadsheet Data Set Admin Role

Some business objects don't allow HSDL templates to be assigned to business user roles. This is usually when the business object uses data security within the application, but that data security isn't available when uploading data using HSDL.

Tip:

You can identify these objects using the View Business Objects task. The Spreadsheet Loading Supported column is Restricted.

Only a Spreadsheet data-set administrator role can use templates based on these objects. This role has access to every active HSDL template.

  • Task 6 lists the steps to create this role.

Objectives

In this tutorial you will:

  • Create a role to configure the business objects your spreadsheet template designer roles can create and import templates for.
  • Create business object specific roles for designing and testing spreadsheet templates.
  • Create business object specific roles for importing and assigning role access to spreadsheet templates on production environments.
  • Create a template admin role for granting access to any template.
  • Create a spreadsheet data-set administrator role that can perform any supported action on all active templates.

Prerequisites

To complete this tutorial, you will need:

  • Access to the Security Console.

Task 1: Grant Access to the Spreadsheet Business Object Access Task

The Spreadsheet Business Object Access task is used to configure which business objects a spreadsheet template designer can create and import templates for. This access would normally be granted to your application administrator. Here you'll define a new custom role to grant access.

  1. Log in to the application with a user that has Security Console access.
  2. Navigate to Tools > Security Console and click Create Role.
  3. Specify a Role Name of HSDL Business Object Access or similar and supply a unique role code.
  4. Specify a Role Category of HCM - Job Roles.
  5. Add these Function Security Policies:
    6. Function Security Policies
    Policy Name Policy Code Grants Access To
    Review HCM Data Loader Business Objects HRC_REVIEW_HDL_BUSINESS_OBJECTS_PRIV View Business Objects task
    Manage Data Exchange Work Area HRC_MANAGE_DATA_EXCHANGE_PRIV Data Exchange work area

    Tip:

    The View Business Objects task lists all supported objects and can be used to find which business objects are owned by each product area.
  6. Add these Role Hierarchies:
    7. Role Hierarchies
    Role Name Role Code Grants Access To
    Manage HCM Spreadsheet Data Loader Business Object Access ORA_HRC_MANAGE_HSDL_BO_ACCESS Spreadsheet Business Object Access task
    Functional Setups User ORA_ASM_FUNCTIONAL_SETUPS_USER_ABSTRACT Setup and Maintenance

  7. Save your changes.

    8. You can now grant this role to the application administrator user responsible for configuring the business objects your HSDL template designers can create and import templates for.


Task 2: Grant Access to Design Spreadsheet Templates

This task describes how to create a role with the access needed to design HSDL templates.

You'll need to create a template designer role for each combination of business object access you require.

Tip:

You can choose to have a single template designer role with access to all the business objects you want to define templates for, or access to all available business objects. Template designer roles allow the user to upload data, so this role should only be created on non-production environments.
  1. Click Create Role in the Roles tab of the Security Console.
  2. Specify a Role Name and Role Code that identifies the business objects this template designer can define templates for. For example, HSDL Template Designer - Worker.
  3. Specify a Role Category of HCM - Job Roles.
  4. Add these Function Security Policies:
    5. Function Security Policies
    Policy Name Policy Code Grants Access To
    Review HCM Data Loader Business Objects HRC_REVIEW_HDL_BUSINESS_OBJECTS_PRIV View Business Objects task

    Tip:

    The View Business Objects task is the data dictionary for all HSDL supported objects. Use it to understand the business object shape and supported attributes when designing spreadsheet templates.
    Manage Data Exchange Work Area HRC_MANAGE_DATA_EXCHANGE_PRIV Data Exchange work area

  5. Add these Role Hierarchies:
    6. Role Hierarchies
    Role Name Role Code Grants Access To
    Manage HCM Spreadsheet Data Loader Templates ORA_HRC_MANAGE_HSDL_TEMPLATES Spreadsheet Templates task
    Load Data using HCM Spreadsheet Data Loader ORA_HRC_LOAD_DATA_USING_HSDL Load data using HSDL spreadsheets

    Caution:

    Don't grant access to the Load Data using HCM Spreadsheet Data Loader role hierarchy on your production environment. Your template designer role shouldn't be able to bulk load data in production environments.

  6. Save your role.
  7. Repeat for your other template designer roles.

Caution:

If you instead create a base role with these permissions and create roles that inherit this, don't assign business object access to your base role. They will be inherited by any role that inherits your base role.


Task 3: Configure Business Object Access

Having created a custom role, you need to assign the objects and product areas users with that role can create and import spreadsheet templates for.

  1. Log into the application with a user that has access to the Spreadsheet Business Object Access task. Refer to Task 1 for how to grant access to this task.
  2. Navigate to My Enterprise > Setup and Maintenance.
  3. Select the HCM Data Loader functional area.

    4. Tip:

    This functional area is available in the Workforce Development and Workforce Deployment setups, amongst others.
  4. Click Spreadsheet Business Object Access.
  5. Search for and select your custom role in the Job and Abstract Roles table.
    6. Search for and select your job role

Assign an Individual Business Object

  1. On the Assigned Business Objects table toolbar, click the Assign choice list and select Assign Individual Business Objects.
    2. Click Assign Individual Business Objects

  2. In the Search and Select Business Objects window, search for and select the Worker business object:
    3. Select the Worker business object

    Tip:

    You can select multiple business objects and add them in one step.
  3. Click Add
  4. Repeat for other individual business object or add product area access as required.
  5. Click Save.

Assign all Business Objects in a Product Area

You can configure your template designer role to have access to create and import templates for all business objects in a product area.

  1. On the Assigned Business Objects table toolbar, click the Assign choice list and select Assign All Business Objects in a Product Area.
    2. Click Assign All Business Objects in a Product Area

  2. In the Select Product Area window, select the product area that the role can create templates for, such as Global HR - Work Structures.
    3. Select Global HR - Work Structures

  3. Click Add.

    4. Tip:

    Use the View Business Objects task in the Data Exchange work area to review the business objects that exist within a product area.
  4. Repeat for additional product areas.
  5. Click Save.

Assign All Business Objects

You can configure your template designer role to have access to any supported HSDL business object.

  1. On the Assigned Business Objects table toolbar, click the Assign choice list and select All Business Objects.
    Click Assign All Business Objects

  2. Click Add to confirm you want to grant access to define templates for any supported objects.
    3. Click Assign All Business Objects

  3. Click Save.

Task 4: Granting Template Maintenance Access for Production

To import your tested templates on to production, assign role access, and activate them, you'll need a template maintenance role on production.

  1. Click Create Role in the Roles tab of the Security Console.
  2. Specify a Role Name and Role Code that identifies the business objects this template designer can define templates for. For example, HSDL Template Maintenance - Worker.

    3. Tip:

    Name the role for the business objects it can create templates for.
  3. Specify a Role Category of HCM - Job Roles.
  4. Add these Function Security Policies:
    5. Function Security Policies
    Policy Name Policy Code Grants Access To
    Manage Data Exchange Work Area HRC_MANAGE_DATA_EXCHANGE_PRIV Data Exchange work area

  5. Add these Role Hierarchies:
    6. Role Hierarchies
    Role Name Role Code Grants Access To
    Manage HCM Spreadsheet Data Loader Templates ORA_HRC_MANAGE_HSDL_TEMPLATES Spreadsheet Templates task

    Caution:

    Don't grant access to the Load Data using HCM Spreadsheet Data Loader role hierarchy on your production environment. Your template maintenance role shouldn't be able to bulk load data in production environments.
  6. Save your role.
  7. Follow the steps in Task 3 to configure the business objects this role can import templates for.

Task 5: Grant Spreadsheet Template Administrator Access

Once a template is made active, business object security is replaced by template security and only the users with a job role configured to maintain a template can assign roles to it. To assign role access to a template you haven't assigned an admin role for, or for preconfigured templates that are already active without a template admin assigned, you'll need a spreadsheet template administrator role.

These steps configure an all-template access role that can be used to assign roles to spreadsheet templates but can't use those templates to bulk-load data.

  1. Log in to the application with a user that has Security Console access.
  2. Navigate to Tools > Security Console and click Create Role.
  3. Specify a Role Name of HSDL All Templates Role Administrator or similar and supply a unique role code.
  4. Specify a Role Category of HCM - Job Roles.
  5. Click Next and on the Function Security Policy page, add these policies:
    6. Function Security Policies
    Policy Name Policy Code Grants Access To
    Manage Data Exchange Work Area HRC_MANAGE_DATA_EXCHANGE_PRIV Data Exchange work area

  6. Navigate to the Role Hierarchy page and add these roles:
    7. Role Hierarchies
    Role Name Role Code Grants Access To
    HCM Spreadsheet Data Loader Template Administration ORA_HRC_HSDL_TEMPLATE_ADMINISTRATION Create and maintain templates for all business objects.

  7. Navigate to the Summary page and click Save and Close.

You can now assign this role to users responsible for maintaining all spreadsheet templates.

Task 6: Grant Administrator Access to Use All Templates

A few business objects use data security in the application but haven't implemented that data security with HSDL. Templates based on these objects can't be assigned to individual roles. Only users with spreadsheet data-set administrator access can use them.

Tip:

Use the View Business Objects task to review the spreadsheet loading support available for each business object.

In this step you'll configure a role with administrator access that will then be able to use any HSDL template, perform all supported data-set operations and view all existing data sets created by any user.

  1. Log in to the application with a user that has Security Console access.
  2. Navigate to Tools > Security Console.
  3. Click Create Role.
  4. Specify a Role Name of HSDL Run All Templates Administrator or similar and supply a unique role code.
  5. Specify a Role Category of HCM - Job Roles.
  6. Click Next and on the Function Security Policy page, add these policies:
    7. Function Security Policies
    Policy Name Policy Code Grants Access To
    Manage Data Exchange Work Area HRC_MANAGE_DATA_EXCHANGE_PRIV Data Exchange work area

  7. Navigate to the Role Hierarchy page and add these roles:
    8. Role Hierarchies
    Role Name Role Code Grants Access To
    Load Data Using HCM Spreadsheet Data Loader ORA_HRC_LOAD_DATA_USING_HSDL Load data using HSDL spreadsheets
    HCM Spreadsheet Data Loader Data Set Administration ORA_HRC_HSDL_DATA_SET_ADMINISTRATION Run HCM Spreadsheet Data Loader for all templates.

  8. Navigate to the Summary page and click Save and Close.

Users granted this role will now be able to load data with any active HSDL template.

Tip:

The Upload Data As setting of a template will decide if data is loaded by the elevated or session user. When data is loaded using the elevated user the created by and last updated by audit attributes are set to FUSION_APPS_HCM_ESS_LOADER_APPID and any data security is ignored.

Help Topics Tutorials

You can find links to the latest Oracle By Example tutorials in this Cloud Customer Connect topic:

Acknowledgements

  • Authors - Ema Johnson (Senior Principal Product Manager)

More Learning Resources

Explore other labs on docs.oracle.com/learn or access more free learning content on the Oracle Learning YouTube channel. Additionally, visit education.oracle.com/learning-explorer to become an Oracle Learning Explorer.

For product documentation, visit Oracle Help Center.