You use the Define Extract window to define and maintain the definition of a system extract.

Your extract definition includes an extract criteria profile and an extract layout definition that you have already defined as well as other parameters needed for the extract batch process, such as the extract date range and the output directory and file name of the extract file.

   To define a system extract:

1. Enter an Extract Name that uniquely identifies this extract definition.

2. Select the kind of data that you want to include in the extract in the Type field.

   • Choose either Full Profile, Changes Only, Compensation Workbench, or Communication.

   Note: Ensure you select the Compensation Workbench type to extract Compensation Workbench data.

3. Enter an XML tag name if you output the system extract file in XML format.

   Note: The XML tag name defaults to the name you assign the record. When you define the Extract Definition, you can choose to extract a text file or an XML file.

4. Select an extract criteria profile in the Inclusion Criteria field to limit the results of the extract.

5. Select a file layout definition in the File Layout field that limits the records included in this extract to those defined in this file layout.

6. Enter the Output Directory where you want to write the results of the extract.

   System Extract validates the directory you enter against the parameter UTL_FILE_DIR set up by your database administrator. If you want to write to additional or different directories, your database administrator must update UTL_FILE_DIR with the additional paths.

7. Enter the name of the output file in the Output File Name field.

8. Select an Output Type to determine the format of the extract file. Choose from:

   • Excel Spreadsheet (HTML)

   • Flat File

   • HTML File

   • PDF File

   • RTF

   • XML File

   Note: Select Flat File to generate a single text file. Select XML File to generate three files with the extensions, .xml, .xsl, and .xsd. Select PDF File if you created a PDF template in Oracle XML Publisher.

9. To enable you to view the extract results from within the Concurrent Manager View Requests window, select the Display Output File in Write Process check box.

10. Check the Append Current Request ID field if you want to add the request ID to the file name.

    In the Options tabbed region:

11. Check the Submit Write Process Automatically field if you want to write the results of this extract to a file when you run the benefits extract batch process.

    Note: If you want to review the results of your extract before writing the results to a file do not check this field. You can write the extract results to a file by running the extract write batch process from the Concurrent Manager.

12. Check the Special Handling for Dependents (ANSI 834, HIPAA) field if you are defining this extract to conform with ANSI 834 or HIPAA standards.

    Note: If you check this field, you should consider selecting the data element of Person Participation Type (ANSI) when defining the layout for this extract to distinguish participant and dependent enrollment records in the extract results.

13. Check the Update Communication Sent Date field if you are defining an extract for communications.

14. Select the name of a PDF Template you created in Oracle XML Publisher if you want to generate a PDF version of an XML extract.

15. Save your work.