Specifying Extract Options

The Options tab of the extract inspector enables you to specify the options, such as the file and data formats, for creating the extract file.

To specify the extract options:

1. On the Options tab of the extract inspector, click Edit.
2. Optional: Define the Filter parameters.
   • Node Filter: Click Define Expression to open the expression builder and define an expression to select the nodes to be extracted. The expression must return a Boolean value, and only nodes where the filter expression is true will be included in the extract. See Using Expressions to Define Custom Business Logic

     Note:

     For generational extracts, the Node Filter is not applied to ancestors.
   • Ancestor Filter (Generational extracts only): Click Define Expression to open the expression builder and define an expression to filter the ancestor nodes to be extracted. Only ancestor nodes where the filter expression is true are included in the extract. This enables you to reduce the levels for a generational extract to allow it to be balanced to a lower depth when the hierarchy has too many levels. See Using Expressions to Define Custom Business Logic

     Optional: Click the X to remove the Node or Ancestor Expression Filter.

   • Filter Logic (Incremental extracts only): Select whether to use the filter logic as an inclusion filter (that is, only nodes that match the filter are included in the extract), or an exclusion filter (nodes that match the filter are excluded from the extract).
   • Reconnect Parents: Select whether or not to reconnect parents in the extract. See Reconnecting Parents In Extracts.

     Note:

     For generational extracts, Reconnect Parents is always enabled and cannot be changed.

   • Exclude Implicitly Shared Nodes (available for extracts from hierarchy viewpoints only): Select whether or not to exclude nodes that have already been processed under the same parent in a different location in the hierarchy. See Understanding Shared Nodes.

     Tip:

     You may want to avoid excluding implicitly shared nodes when you are extracting positional information, such as ancestors, inherited values, or default derived values that use positional logic.

3. Define the File Format options:

   Table 26-3 File Format Options

   Field	Description	Example
   Delimiter Character	Character that separates text strings. Select a value, or select Other and enter the delimiter character. You can enter more than one character as a delimiter.	Comma
   Line Feed Style	Character that advances to the next line	CR+LF (Windows) CR Only (Mac) LF Only (Linux)
   Quote Columns	Columns that require a quote character: None All Columns As Needed By Value: (Default) adds quote character to columns that contain special characters such as: Delimiter character Quote character Line feed character Note: Quoting options are not applied to custom headers and footers.	None
   Quote Character	Character used to indicate quote columns	Single Quote
   Null Keyword	Keyword to replace null values in the file	Blank
   Defined Empty String Keyword	Keyword to replace defined empty values in the file	No Data
   Pivot Delimiter	For string data type properties only, the character that separates the strings to pivot on. Select a value, or select Other and enter the delimiter character. You can enter more than one character as a delimiter.	Comma
   Include Column Header Record	Indicator to include the header record at the beginning of the file	Selected
   Include Custom Header	Select to include a custom header record If selected, enter a custom header to include. You can insert substitution parameters in custom headers. See Using Substitution Parameters in Custom Headers and Footers, below. If you are also using the generated column header record, specify if the custom header should be placed before or after the generated column header.	BOF (Beginning of file indicator)
   Include Custom Footer	Select to include a custom footer record If selected, enter a custom footer to include. You can insert substitution parameters in custom footers. See Using Substitution Parameters in Custom Headers and Footers, below.	EOF (End of file indicator)

4. Define the Data Format options:

   Table 26-4 Data Format Options

   Field	Description	Example
   Negative Sign	Character that indicates a negative value	Parenthesis
   Thousands Separator	Character that separates thousands in numbers	Comma
   Decimal Separator	Character that separates decimals in numbers Note: You cannot use the same character for both separators. When you select a character for one separator, that character is removed from the drop down menu for the other separator.	Dot
   Boolean Values	Specify whether to extract the actual value, the displayed value, or specified values for boolean properties. Note: If you select Specified, enter the values to represent True and False. You can enter blank values for either option.	Specified Specified Value for True: IC_INTERCOMPANY_YES Specified Value for False:
   Allowed Value Properties	Specify whether to extract the actual value or the displayed value for an allowed value property.	Display
   Time Zone	Time zone for the extract	UTC
   Date Format	Select a date format from the drop down menu, or select Specified and enter a date format. Note: See Date and Time Formatting Symbols.	MM/dd/yyyy
   Time Format	Select a time format from the drop down menu, or select Specified and enter a time format. Note: The Example Date/Time field displays the date and time format that you select or specify.	HH:mm:ss

5. Click Save.

Note:

The Time Zone, Date Format, and Time Format are saved at the extract level. This means that the time zone and formats in the extract will always be the same regardless the locale of the user who runs it.

Using Substitution Parameters in Custom Headers and Footers

You can enter substitution parameters in custom headers and footers. When you run the extract, the value for the parameter is inserted into the extract. For example, if you enter <%Date%> in a custom footer, when you run the extract the date that the extract was run is inserted into the footer.

Tip:

Substitution parameters are not case-sensitive.

The following substitution parameters are available:

• <%Date%>: Returns the date the extract was run, based on the extracts settings for time zone and format . If the time zone is not set, then UTC is used.
• <%Time%>: Returns the time the extract was run, based on the extracts settings for time zone and format . If the time zone is not set, then UTC is used.
• <%Timestamp%>: Returns the combination of the date and time the extract was run, based on the extracts settings for time zone and format .
• <%Username%>: Returns the username performing the extract.
• <%UserFirstName%>: Returns the first name of the user performing the extract.
• <%UserLastName%>: Returns the last name of the user performing the extract.
• <%UserEmail%>: Returns the email address of the user performing the extract.
• <%ExtractName%>: Returns the name of extract.
• <%FileName%>: Returns the extract file name.
• <%RecordCount%>: Returns the count of records extracted. This count excludes the header and footer rows in the record count, but it does include pivoted rows so that it matches the last record count used.

  Note:

  This parameter is available in custom footer rows only. You cannot insert the record count in a custom header.
• <%AppVersion%>: Returns the Oracle Enterprise Data Management Cloud release number (for example, "Oracle EDM Cloud Release 22.09").