HCM Data Loader Configuration Parameters
The HCM Data Loader configuration parameters control the HCM Data Loader and HCM Spreadsheet Data Loader import and load processes. The default settings of the parameters suit most requirements.
However, you can override these settings to suit the configuration of your environment and the amount of data being loaded. Users can also override most enterprise settings for individual load processes.
In the Setup and Maintenance work area, use the following to review or override the predefined settings for the enterprise:
-
Functional Area: HCM Data Loader
-
Task: Configure HCM Data Loader
On the Configure HCM Data Loader page, select the HCM Data Loader tab. You can filter the parameters by these category values:
-
Availability
-
Diagnostics
-
File Definition
-
Performance
-
Scheduling Default
Parameters that are specific to a business object appear in a separate section. This topic describes each of the configuration parameters within its category. Object-specific parameters are described following the category sections.
Availability Parameters
Enable Automatic Extended Data Set Retention
Determines whether data sets for business objects that support validate or rollback are automatically retained beyond the standard retention period. You can override the default behavior using a SET instruction. You control how long extended retention data sets are kept for using the Days to Preserve Extended Retention Data Sets parameter.
Default Value: No
Enable Audit Data
Specifies whether audit data is captured for business objects loaded using HCM Data Loader. If you set this parameter to Yes, then audit must also be enabled for Oracle Fusion Applications.
You can set this parameter separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Default Value: No
Enable Bulk-Ingestion of Oracle Search Indexes
Enable changes uploaded by HDL and HSDL to be bulk-ingested into Oracle Search indexes. When disabled, incremental ingestion is used.
Default Value: Yes
Enable Configuration of Role-Based Business Object Access
Determines whether access to HCM Data Loader business objects is configurable by role. When enabled you must configure the business objects a custom role can load data with.
Default Value: No
Enable File Generation for Failed File Lines
Determines whether you can generate business object files for the files lines that failed to load.
Default Value: No
Enable HCM Data Loader Post Process Configuration
Determines whether configuration of the processes to be automatically submitted after a data load is enabled.
Default Value: Yes
Enable Load Events for Incremental Updates
Enable events to be triggered for the data supplied. Enabling load events will significantly increase the time it takes for your data to load. You can override this parameter with a set instruction followed by the override value. Place SET instructions before the first METADATA line in your business object file.
Default Value: No
Enable Load Group Size Calculation
Specifies whether the load-group size is to be calculated automatically. Set to Yes to enable the optimal load-group size to be calculated based on the number of objects to process and the available concurrent threads. When Enable Load Group Size Calculation is Yes, the Load Group Size parameter doesn't appear on the Schedule Request page. Also, the default value of the Load Group Size parameter is ignored.
Default Value: Yes
Enable UI Message Translation
Specifies whether messages on the Import and Load Data page are to appear in the language of the signed-in user. Set to Yes to enable translated messages. If this parameter is set to No, then messages appear in the language of the user who submitted the import and load request.
Default Value: No
Generate Business Object Mapping Files
Specifies one of three options for generating Business Object Mapping Files. The mapping file describes the HCM Data Loader shape, and you can import this into Oracle Integration Cloud to define transformation and mappings rules.
The default value of No means you haven't enabled the option to generate mapping files.
The Custom only value lets you generate mapping files for business object dat files you upload to HCM Data Loader. Only the attributes included in the uploaded file will be included in the mapping file. Under the Parameters section, select the Generate Objects Mapping File feature. Refresh the Business Objects task bar until the Download Mapping File link activates and then you can retrieve the map.
A parameter value of Yes lets you request a mapping file from the Import and Load Data interface, just like Custom only. In addition, on the View Business Objects page, you can Refresh an individual object and it will automatically generate a mapping file for you. Refresh the page until Last Refreshed indicates today's date. Download the mapping file using the link under Integration Mapping File.
Default Value: No
Purge Person Enabled Key
Key value supplied by Oracle Support to enable the Purge Person Data in Test Environments process.
You can't enable and run this process in production environments.
Default Value: None
Enable Load Events for Incremental Updates
Specifies whether incremental load events are enabled when bulk-loading data.
Default Value: No
Enable Mandatory Descriptive Flexfield Segment Validation
Determines whether an error is raised when loading descriptive flexfield data, a mandatory segment is without a value, and no default is configured.
Default Value: No
Restrict Access to Security Related Business Objects
Determines whether users with a role granted with the Load HCM Security Data function security privilege can bulk-load data using security related objects. When set to Yes, only users with a role that is granted the Load HCM Security Data function security privilege will be able to bulk-load data using security related objects, such as User and Delegated Role. When set to No, users that aren't granted the Load HCM Security Data function security privilege will encounter warnings when loading security-related data, but the uploads will continue.
For more information, refer How You Enable Access to HCM Data Loader.
Diagnostics Parameters
Complex Error Stack Trace Occurrences by Thread
Maximum number of complex error message occurrences on a processing thread for which stack trace is recorded.
Default Value: 5
Data Error Stack Trace Occurrences by Thread
Maximum number of data error message occurrences on a processing thread for which stack trace is recorded.
Default Value: 2
File Definition Parameters
Data Set Name
For data loads initiated by web service, specifies whether the Oracle WebCenter Content document title or the .zip file name is used as the data set name.
Default Value: File name
File Character Set
Character set used for business object and attachment files.
Default Value: UTF-8
File Delimiter
A value of up to 10 characters used to separate attribute names on METADATA lines and attribute values on data lines.
Default Value: Vertical bar (|)
File Encryption
Default file encryption.
Default Value: None
File Escape Indicator
A value of up to 10 characters used to indicate that the next character is to be ignored on data lines.
Default Value: Backslash (\)
File New Line Indicator
A value of up to 10 characters used to indicate a new line in an attribute value. This value must be preceded by the file escape indicator.
Default Value: n
Flexfields Enabled
Controls whether flexfield data can be loaded.
Default Value: Yes
Purge Audit Data
Specifies whether audit data is to be purged automatically for objects successfully updated or deleted.
Default Value: No
Performance Parameters
Days to Preserve Standard Data Sets Before Archiving
Number of days since a standard data set was last updated before it can be automatically archived. Data sets are only archived if the number of stage table lines exceed the configured limit.
Default Value: 5
Days to Preserve Standard Data Sets Before Deleting
The number of days since a standard data set was last updated before it's automatically and permanently deleted from the stage tables.
Default Value: 30
Days to Preserve Extended Retention Data Sets
Number of days since an extended retention data set was last updated before it’s automatically deleted from the stage tables. Only data sets that contain data which can be validated or rolled back can be retained for extended periods.
Default Value: 60
Load Group Size
Number of business objects processed as a single unit of work by a single thread.
Default Value: 100
Maximum Concurrent Threads for Import
Maximum number of threads to run concurrently when importing data to the stage tables.
You can set this parameter separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Default Value: 8
Maximum Concurrent Threads for Load
Maximum number of threads to run concurrently when loading data from the stage tables to the application tables.
This parameter is used in conjunction with the Load Group Size parameter. Only the threads required to load your objects based on the Load Group Size parameter are created.
Default Value: 8
Maximum Data Lines Before Archiving
The number of data lines that can be held in the stage tables before data sets are automatically backed up.
Default Value: 10000000
Transfer Group Size
Number of file lines processed as a single unit of work by a concurrent thread.
Default Value: 100000
Scheduling Default Parameters
Date-Effective Update Mode
Specifies whether future-dated records should be purged when date-effective objects are loaded.
You can set this parameter separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Default Value: Replace
Delete Source File
Specifies whether to delete source files from the Oracle WebCenter Content server once they have been processed.
Default Value: Yes
Disable Post Process Tasks
This parameter is read-only. You can disable individual postload processes by including a SET instruction in the relevant Worker.dat or Position.dat file.
Default Value: None
File Action
Default file-processing action.
Import and load means that valid objects are loaded automatically once import completes. Import only means that your data is imported to the stage tables, but load isn't initiated.
Default Value: Import and load
Initiate Business Object Post Processing
Specifies whether processes registered to run automatically after an object is loaded should run.
You can set this parameter separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Default Value: Yes
Maximum Percentage of Import Errors
Percentage of file lines in error that can occur in a business object before the import process stops for the object.
Default Value: 100
Maximum Percentage of Load Errors
Percentage of business-object instances in error that can occur for a business object before the load process stops.
You can set this parameter separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Default Value: 100
Business Object Parameters: Worker
You can set these parameters separately for HCM Data Loader and HCM Spreadsheet Data Loader.
Calculate Worker Full-Time Equivalent
Specifies whether the full-time equivalent (FTE) value should be calculated automatically for all worker assignments in a Worker.dat file.
Default Value: No
Create Worker Default Work Hour Pattern
Specifies whether a default working-hour pattern should be created automatically for all worker assignments in a Worker.dat file.
Default Value: No
Business Object Parameters: Participant Enrollment
Evaluate Life Events
Determines whether life events should be evaluated when loading Participant Enrollment data.
Default Value: No
Business Object Parameters: Succession Plan
Retain Succession Plan History
Determines whether historical data is retained for changes to succession plans.
You can set this parameter separately for HCM Data Loader, HCM Spreadsheet Data Loader and HCM Spreadsheet Data Loader templates.
Default Value: Yes