The SET Instruction

The SET instruction is optional in a .dat file and has no discriminator. You use SET instructions to alter default processing for the file in which they appear.

You can include any number of SET instructions in a .dat file, but they must appear before the first METADATA line. This topic describes when to use the SET instruction.

This table lists the SET instructions and their default values.

Instruction	Default Value
SET PURGE_FUTURE_CHANGES Y|N	Y
SET DISABLE_POST_PROCESS_TASKS <process>	Not applicable
SET INVOKE_POST_PROCESS Y|N	Y
SET FILE_DELIMITER <delimiter>	Vertical bar (|)
SET FILE_ESCAPE <escape character>	Backslash (\)
SET FILE_NEWLINE <newline character>	n
SET ENABLE_AUDIT_DATA Y|N	N
SET PURGE_AUDIT_DATA Y|N	N
SET CALCULATE_FTE Y|N	N
SET CREATE_DEFAULT_WORKING_HOUR_PATTERN Y|N	N
SET ENABLE_INCREMENTAL_LOAD_EVENTS Y|N Note: Enabling events for your file may increase the time it takes to load.	N
SET EXTEND_DATA_SET_RETENTION Y|N Note: Extending the retention period of a data set will lengthen the time it takes to load, as after processing the staging table data is moved from the primary to the secondary staging tables.	N
SET EVALUATE_LIFE_EVENTS Y|N	N
SET RETAIN_SUCCESSION_PLAN_HISTORY Y|N	Y
SET ORA_ENABLE_OS_BULK_INGEST Y|N	Y
SET ORACLE_SEARCH_UPDATE_MODE ORA_BULK|ORA_INITIAL	ORA_BULK
SET ENABLE_LOCATION_ADDRESS_VALIDATION Y|N	Y
SET ENABLE_WORKER_ADDRESS_VALIDATION Y|N	Y

Tip: The default values shown here are predefined for the enterprise. You can override these values for the enterprise using the Configure HCM Data Loader task in the Setup and Maintenance work area.

SET Instruction Descriptions

This section provides an alphabetic list of all SET instructions with their descriptions.

SET CALCULATE_FTE

To request automatic calculation of full-time equivalent (FTE) values for all worker assignments in a Worker.dat file, include the SET CALCULATE_FTE instruction. For example:

SET CALCULATE_FTE Y

SET CREATE_DEFAULT_WORKING_HOUR_PATTERN

To request automatic creation of a default working-hour pattern for all worker assignments in a Worker.dat file, include the SET CREATE_DEFAULT_WORKING_HOUR_PATTERN instruction. For example:

SET CREATE_DEFAULT_WORKING_HOUR_PATTERN Y

SET DISABLE_POST_PROCESS_TASKS

By default, these processes run automatically after you load workers:

• Refresh Manager Hierarchy

• Update Person Search Keywords

To prevent Refresh Manager Hierarchy from running automatically, you can include this SET instruction in the Worker.dat file:

SET DISABLE_POST_PROCESS_TASKS RefreshManagerHierarchy

To prevent Update Person Search Keywords from running automatically, you can include this SET instruction in the Worker.dat file:

SET DISABLE_POST_PROCESS_TASKS UpdatePersonSearchKeywords

By default, the FlattenPositionHierarchy process runs automatically after you load HCM position hierarchies. To prevent FlattenPositionHierarchy from running automatically, include this SET instruction in the PositionHierarchy.dat file:

SET DISABLE_POST_PROCESS_TASKS FlattenPositionHierarchy

Tip: To prevent postload processes from running automatically, you can use the SET INVOKE_POST_PROCESS instruction instead.

SET ENABLE_AUDIT_DATA

Audit of objects loaded using HCM Data Loader is enabled or disabled for the enterprise using the Enable Audit Data configuration parameter. You can override the enterprise setting for individual .dat files by including this SET instruction. For example, if audit is enabled for the enterprise, then you can disable it for an individual .dat file.

SET FILE_DELIMITER

Use this instruction to change the default file delimiter, which is the vertical bar (|). For example, to change it to a comma, include this instruction:

SET FILE_DELIMITER ,

The new value can be up to 10 characters.

SET FILE_ESCAPE

Use this instruction to change the default file escape character, which is the backslash (\). For example, to change it to the equal sign (=), include this instruction:

SET FILE_ESCAPE =

The new value can be up to 10 characters.

SET EXTEND_DATA_SET_RETENTION

By default, all data sets are automatically and permanently deleted after a maximum of 30 days since they were last updated. If you are loading data which is to be validated, or may need to be rolled back, you can use this instruction to extend the retention period of the data set.

Supply this instruction only in business object files that support validate or roll back. If you are supplying multiple business object files that support validate or roll back, you need only supply this instruction once.

SET EXTEND_DATA_SET_RETENTION Y

Note: The time it takes to complete the processing of your file will be longer, as after loading the valid data into the application tables, the staging table data is moved from the primary to the secondary staging tables, so it doesn't negatively impact the processing time of subsequent files.

SET FILE_NEWLINE

Use this instruction to change the default file newline character, which is the character n. For example, to change it to the string newline, include this instruction:

SET FILE_NEW_LINE newline

The new value can be up to 10 characters.

SET INVOKE_POST_PROCESS

By default, these processes run automatically after you load workers:

• Refresh Manager Hierarchy

• Update Person Search Keywords

By default, the FlattenPositionHierarchy process runs automatically after you load HCM position hierarchies.

To prevent such processes from running automatically, you can include this SET instruction in the relevant .dat file:

SET INVOKE_POST_PROCESS N

SET PURGE_AUDIT_DATA

Use this instruction to purge the audit data for the objects in a .dat file. This feature is intended primarily to remove the audit records for personally identifiable information in worker records.

You can't include both of the following instructions in a single .dat file:

• SET ENABLE_AUDIT_DATA Y

• SET PURGE_AUDIT_DATA Y

If auditing of loaded objects is enabled for the enterprise, then you must disable it in any .dat file where you're purging audit data. That is, you include the following instructions:

• SET ENABLE_AUDIT_DATA N

• SET PURGE_AUDIT_DATA Y

SET PURGE_FUTURE_CHANGES

When you create business objects containing date-effective components, you include this instruction at the start of the file:

SET PURGE_FUTURE_CHANGES Y

This instruction sets the date-effective maintenance mode to Replace. In this mode, which is the default mode, the contents of the .dat file replace any existing data.

When you update business objects containing date-effective components, you include this instruction at the start of the file:

SET PURGE_FUTURE_CHANGES N

This instruction sets the date-effective maintenance mode to Retain. In this mode, any existing future-dated changes are retained.

SET ENABLE_INCREMENTAL_LOAD_EVENTS

To enable the firing of atom feeds and events that are triggered by the changes supplied in a file, include the SET ENABLE_INCREMENTAL_LOAD_EVENTS instruction. For example

SET ENABLE_INCREMENTAL_LOAD_EVENTS Y

Note: Events are only triggered if they are enabled in your environment. Enabling events for your file may increase the time it takes to load.

SET RETAIN_SUCCESSION_PLAN_HISTORY

Determines whether historical data is retained for changes to succession plans. To prevent the retention of history, include the SET RETAIN_SUCCESSION_PLAN_HISTORY instruction in your SuccessionPlan.dat files. For example:

SET RETAIN_SUCCESSION_PLAN_HISTORY N

SET ORA_ENABLE_OS_BULK_INGEST

To automatically submits the Update Oracle Search with HCM Data Loader Changes process to maintain the Oracle Search indexes with the changes made.

SET ORA_ENABLE_OS_BULK_INGEST Y

SET ORA_UPDATE_ORACLE_SEARCH

To enable bulk-ingestion include the following instruction at the top of your file:

SET ORA_UPDATE_ORACLE_SEARCH ORA_BULK

It enables the capture of Fusion surrogate IDs for Oracle Search bulk-ingestion and the automated submission of the Update Oracle Search with HCM Data Loader Changes process.

SET ENABLE_WORKER_ADDRESS_VALIDATION

To enable worker address validation include the following instruction at the top of your file:

SET ENABLE_WORKER_ADDRESS_VALIDATION Y

SET ENABLE_LOCATION_ADDRESS_VALIDATION

To enable location address validation include the following instruction at the top of your file:

SET ENABLE_LOCATION_ADDRESS_VALIDATION Y