1. Using Common Features for HCM
  2. File Format for Importing Descriptive Flexfields

File Format for Importing Descriptive Flexfields

You can import descriptive flexfields to your application by creating separate text files containing contexts and segments. You can then upload these files to the Oracle WebCenter Content document repository.

Here are a few things that you need to keep in mind while creating these files:

  • Use a vertical bar or pipe ( | ) as a delimiter between fields for both the header and the value rows.
  • According to the Oracle WebCenter Content specification, set the file encoding to UTF-8 without the Byte Order Mark (BOM).
  • Make sure the first line in the file is a header line, and the files look exactly the same as shown in the sample file.

The following sections contain specific details about each file format.

Context

To create a file containing the contexts, include the headers specified in this table:

Header

Data Type

Data Size

Description

Required or Optional

ApplicationId

Long

-

This value determines the application your flexfield and context belong to.

Required

DFFCode

String

40

This value is the code of the descriptive flexfield where you're adding your context. The value should match the code of a descriptive flexfield that's already in the application.

Required

ContextCode

String

80

This value is the code for your context.

Required

Name

String

80

This value determines the display name of your context.

Required

EnabledFlag

String

1
This value lets you enable or disable your context:
  • Y: Enable context
  • N: Disable context

Required

Description

String

240

This value describes your context.

Optional

ContextIdentifier

String

30

This value determines the API name for your context. While naming APIs, follow the naming conventions.

Optional

Here's a sample file for contexts. You can see the header values at the beginning of the file, followed by the line entries of the two value set codes to be imported. For importing several contexts, add more entries in the same format.

ApplicationId|DFFCode|ContextCode|Name|EnabledFlag|Description
0|TEST_DEPLOY_DFF1|LOADER_Con1|Loader con Name|Y|Description

Segment Label

To create a file containing context segments, include the headers specified in this table:

Header

Data Type

Data Size

Description

Required or Optional

ApplicationId

Long

-

This value determines the application your flexfield, context, and segment belong to.

Required

DFFCode

String

40

This value is the code of the descriptive flexfield where you're adding your segment. The value should match the code of a descriptive flexfield that's already in the application.

Required

SegmentLabelCode

String

30

This value is the code for your segment.

Required

Name

String

80

This value is the name of your segment.

Required

Description

String

240

This value describes your segment.

Optional

BIObjectName

String

128

This value provides the name for the BI-enabled segment.

Optional

Here's a sample file for the segment label. You can see the header values at the beginning of the file, followed by the line entries of the two value set codes to be imported. For importing several segment labels, add more entries in the same format.

ApplicationId|DFFCode|SegmentLabelCode|Name|Description|BIObjectName
0|FLEX_DFF1|Label Code 1|Label name 1|Description 1| BIObJ1

Segment

To create a file containing context segments, include the headers specified in this table:

Header

Data Type

Data Size

Description

Required or Optional

ApplicationId

Long

-

This value determines the application your flexfield, context, and segment belong to.

Required

DFFCode

String

40

This value is the code of the descriptive flexfield where you're adding your segment. The value should match the code of a descriptive flexfield that's already in the application.

Required

ContextCode

String

80

This value is the code for the context where you're adding your segment. The value should match a context code that's in the application. For Global Segments, use the value for the field as Global Data Elements.

Required

SegmentCode

String

30

This value is the code for your segment.

Required

Name

String

60

This value is the name of your segment.

Required

ColumnName

String

30

This value determines the table column that your segment uses to save data. The value must match a column that's in the application.

Required

ValueSetCode

String

60

This value is the code for the value set you want to use in your segment. The value must match a value set code in the application.

Required

DisplayType

String

30

This value determines the display type of the segment. Here are the valid values for this attribute:

  • INPUT_SEARCH
  • TEXT_BOX
  • TEXT_AREA
  • HIDDEN,LOV
  • POP_UP_LIST
  • DROP_DOWN_LIST
  • RADIO_BUTTON_GROUP
  • CHECKBOX
  • DATE_TIME

Required

Prompt

String

80

This value determines the display name of the segment.

Required

ShortPrompt

String

80

This value determines the shortened display name of the segment.

Required

EnabledFlag

String

1
This value lets you enable or disable your segment:
  • Y: Enable segment
  • N: Disable Segment

Required

RequiredFlag

String

1
This value indicates whether you must specify the segment:
  • Y: You must specify the segment.
  • N: You may not specify the segment.

Required

ReadOnlyFlag

String

1
This value lets you set your segment to be read-only:
  • Y: The segment is set to read-only.
  • N: The segment isn't set to read-only.

Required

Description

String

240

This value describes your segment.

Optional

UOMclass

String

20

This value specifies the unit for the data that you add to your segment.

Optional

TerminologyHelpText

String

80

This value describes the segment.

Optional

InFieldHelpText

String

160

This value provides instructions on how to use the segment.

Optional

SequenceNumber

Integer

-

This value specifies the order in which your segments display in your context.

Optional

DefaultType

String

30
This value specifies the type of default value for your segment. Here are the types of default values:
  • CONSTANT
  • SQL
  • GROOVY_EXPRESSION

Optional

DefaultValue

String

4000

This value provides the default values for your segment.

Optional

DisplayWidth

Integer

-

This value specifies the maximum number of characters that can display in a line.

Optional

DisplayHeight

Integer

-

This value specifies the maximum number of lines that can display in the segment.

Optional

RangeType

String

30

This value specifies the range of values for the low-end and high-end fields. You can set the respective field value as LOW or HIGH.

Optional

BIEnabledFlag

String

1
This value indicates whether your segment is BI enabled:
  • Y: Your segment is BI enabled.
  • N: Your segment isn't BI enabled.

Optional

SegmentIdentifier

String

30

This value determines the API name for your segment. While naming APIs, follow the naming conventions.

Optional

Here's a sample file for a segment. You can see the header values at the beginning of the file, followed by the line entries of the two value set codes to be imported. For importing several segment labels, add more entries in the same format.

ApplicationId|DFFCode|ContextCode|SegmentCode|Name|ColumnName|ValueSetCode|DisplayType|Prompt|ShortPrompt|EnabledFlag|RequiredFlag|ReadOnlyFlag|Description|UomClass|BIEnabledFlag|BIEqualizationTag
0|FLEX_DFF1|Global Data Elements|SWAMY_TEST_GSEG1|Global seg 1|ATTRIBUTE10_VARCHAR2|EFF_BASIC_FMT_CHR|TEXT_BOX|Prompt|Short Prompt|Y|N|N|TEST desc aug LABEL TAG 1NOV LOAD && ||Y|LabelC1

Related Topics