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:

On the Options tab of the extract inspector, click Edit.
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 (not available for Link extracts): 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, and not available for Link extracts): 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.

Define the File Format options:

Table 30-3 File Format Options

Field	Description	Example
Delimiter Characters (Text file type extracts only)	Character that separates text strings. Select from these options: `Comma` `Space` `Tab` `Specified`: Enter the delimiter characters in the Delimiter field. You can enter more than one character as a delimiter up to a maximum of 10.) Note: Leading and trailing whitespace characters are supported. For example, adding a space after a comma delimiter results in the extract displaying "A, B, C" instead of "A,B,C". `None - Fixed Width` (available for Full extracts only): Formats the extract output using fixed column widths instead of delimiter characters. See Fixed Width Output in Extracts.	`Comma`
Line Feed Style (Text file type extracts only)	Character that advances to the next line	`CR+LF` (Windows) `CR Only` (Mac) `LF Only` (Linux)
Quote Columns (not applicable when Delimiter Characters is set to `None - Fixed Width`)	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`
Top Node Keyword	Keyword to use for the parent column property values for the top nodes in the hierarchy. If this is not provided, then a blank value is output in the parent column for top nodes.	`Root`
Pivot Delimiter	For string data type properties only, the character that separates the strings to pivot on. Select a value, or select Specified and enter the delimiter character. You can enter more than one character as a delimiter up to a maximum of 10, and you can use whitespace characters (such as Tab).	`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)
Null When Property Missing on Node Type	Select to specify that if a property is not used by the node type of the node being extracted, a null value is output for that property instead of the application override settings for inherited or default value. If a Null Keyword has been specified, that keyword will be output for the property.	`Selected`

Define the Data Format options:

Table 30-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 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`

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.

Fixed Width Output in Extracts

Select None - Fixed Width in the Delimiter Characters field to specify that the extract should use fixed column widths instead of delimiter characters to determine the columns in the extract file (available for Full extracts only).

The width of each column is determined as follows:

Table 30-5 Column Widths by Column Type

Column Type	Width in Characters
Specialty Columns
Constant	Length of Constant
Extract Run ID	36
Extract Timestamp	Based on the date and time formats in the Extract Options
Inverted Level	4
Record Number	8
User Name	32
Property Columns
Boolean	Based on property data type display: Y/N, T/F, 1/0: 1 Yes/No: 3 True/False: 5
Date	The maximum length of the date format in the Extract Options
Float	Length of maximum value (including thousands separator and number of decimal places +1). If there is no maximum value then the length is set to 16.
Integer	Length of maximum value (including thousands separator). If there is no maximum value then the length is set to 16.
List	255
Memo	Length of maximum value. If there is no maximum value then the length is set to 1024.
Node List	255
Node	Maximum length of Core.Name property of the target node types. If there is no maximum value then the length is set to 250.
Numeric String	Length of maximum value. If there is no maximum value then the length is set to 32.
Sequence	Length of padding value. If there is no padding value then the length is set to 40.
String	Maximum length of string value. If there is no maximum length then the length is set to 1024.
Timestamp	The maximum length of the date and time formats in the Extract Options, including the space between date and time.

Note:

Values that are shorter in length than the fixed column width are padded with Space characters. Values that are greater in length than the fixed column width are truncated.

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.
<%ExtractName%>: Returns the name of extract.
<%FileName%>: Returns the extract file name.
<%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 .
<%TimeLabelName%>: Returns the name of the time label that is associated with the viewpoint.

Note:
This parameter is available only for extracts that use a time labeled viewpoint with a historical time label. If a private time label is available, that time label name is inserted into the extract. Otherwise, the public time label name is inserted.
<%TimeLabelTimestamp%>: Returns the timestamp of the time label that is associated with the viewpoint, based on the extracts settings for time zone and format.

Note:
This parameter is available only for extracts that use a time labeled viewpoint with a historical time label. If a private time label is available, that time label timestamp is inserted into the extract. Otherwise, the public time label timestamp is inserted.
<%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.
<%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 Fusion Cloud Enterprise Data Management release number (for example, "Oracle EDM Cloud Release 25.09").