File Format for Importing Extensible Flexfields
You can import extensible flexfields to your application by creating separate text files containing value sets, contexts, and context 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.
Value Sets
To create a file containing value sets, include the headers specified in this table:
Header |
Data Type |
Data Size |
Description |
Required or Optional |
---|---|---|---|---|
|
String |
60 |
This value identifies your value set across components. |
Required |
|
String |
60 |
This value determines the module type of your value set. |
Required |
|
String |
60 |
This value determines the specific module of your value set. |
Required |
|
String |
30 |
This value determines your value set type. Here are the types of value
set:
|
Required |
|
String |
30 |
This value determines the data type that your value set uses. Here are
the supported data types:
|
Required |
|
String |
30 |
This value determines the data subtype that your value set uses. Here are
the supported data subtypes:
|
Required for |
|
Integer |
- |
This value determines the maximum length of values in your value set. |
Required for |
|
String |
240 |
This value describes your value set. |
Optional |
|
Integer |
- |
This value determines the number of digits in the number data that you add to your value set. |
Optional Use this header only for |
|
Integer |
- |
This value determines the number of digits after the decimal point in the number data that you add to your value set. |
Optional Use this header only for |
|
String |
1 |
This value indicates whether only uppercase characters are supported
for your value sets:
|
Optional Use this header only for |
|
String |
1 |
This value lets you add zeroes to the left of the text you add in your
value set till the text length matches the value in the
MaximumLength header:
|
Optional Use this header only for |
|
String |
1 |
This value indicates whether data security resource is added to your
value set:
|
Optional |
|
String |
60 |
This value selects the data security resource that you want to add to your value set. The value must match a data security resource in the application. |
Required if |
|
String |
150 |
This value specifies the minimum value for the values in your value set. |
Optional |
|
String |
150 |
This value specifies the maximum value for the values in your value set. |
Optional |
|
String |
60 |
This value determines the independent value set your dependent or subset value set is linked to. |
Required for only Don't use this header for any other validation types. |
Here's a sample file for value sets. You can see the header values at the beginning of the file, followed by the line entries of the three value sets that are to be imported. For importing several value sets, add more entries in the same format.
ValueSetCode|ModuleType|ModuleKey|ValidationType|ValueDataType|ValueSubtype|MaximumLength|Description
VS_TEST_91|APPLICATION|FND|INDEP|VARCHAR2|TEXT|2|desc1
VS_TEST_92|APPLICATION|FND|INDEP|VARCHAR2|TEXT|3|
VS_TEST_93|APPLICATION|FND|INDEP|VARCHAR2|TEXT|3|desc3
Context
To create a file containing the contexts, include the headers specified in this table:
Header |
Data Type |
Data Size |
Description |
Required or Optional |
---|---|---|---|---|
|
Long |
- |
This value determines the application your flexfield and context belong to. |
Required |
|
String |
40 |
This value is the code of the extensible flexfield where you're adding your context. The value should match the code of an extensible flexfield that's already in the application. |
Required |
|
String |
80 |
This value is the code for your context. |
Required |
|
String |
80 |
This value determines the display name of your context. |
Required |
|
String |
1 |
This value indicates whether multiple rows are supported for your context:
|
Required |
|
String |
1 |
This value lets you enable or disable your context:
|
Required |
|
String |
240 |
This value describes your context. |
Optional |
|
String |
1 |
This value indicates whether the segments in your context are
translatable:
|
Optional |
|
String |
30 |
This value determines the API name for your context. While naming APIs, follow the naming conventions. |
Optional |
|
String |
400 |
This value provides user instructions on how to use the context region. |
Optional |
|
String |
30 |
This value determines the usage code for your context. The value should match a usage code in the application. |
Required |
|
String |
400 |
This value determines the privileges that can view this context usage. The value should match a privilege in the application. |
Optional |
|
String |
400 |
This value determines the privileges that can edit this context usage. The value should match a privilege in the application. |
Optional |
|
String |
150 |
This value adds a user-defined attribute to a context usage. To add your user-defined attributes, you can use up to 5 headers of this
type, |
Optional |
|
String |
150 |
This value adds a user-defined attribute to a context. You can use up to 5 headers of this type, |
Optional |
|
String |
15 |
This value is used as a prefix for the database view name for a given context. While entering this value, follow the naming conventions similar to that of flexfield API names. |
Optional |
Here's a sample file that contains the header values at the beginning and lists three contexts to be imported. For importing several contexts, add more entries in the same format.
ApplicationId|EFFCode|ContextCode|Name|EnabledFlag|MultirowFlag|Description|FlexfieldUsageCode|ViewPrivilegeName|CExtAttribute1|CExtAttribute2|CExtAttribute3|CExtAttribute4|CExtAttribute5
0|FLEX_SN_EFF1|OBJ_TEST_4|Object test 44|Y|N|desc 44 3363|FLEX_SN_EFF1_USAGE2|flex_sn_sitems_view|||||
0|FLEX_SN_EFF1|OBJ_TEST_3|Object test 33|Y|N||FLEX_SN_EFF1_USAGE1|flex_sn_view|||||NEW_TEST11
0|FLEX_SN_EFF1|OBJ_TEST_3|Object test 33|Y|N|new desc aug 14|FLEX_SN_EFF1_USAGE2|flex_sn_sitems_edit|CE1_TESTupd_aug15||||
Context Segment
To create a file containing context segments, include the headers specified in this table:
Header |
Data Type |
Data Size |
Description |
Required or Optional |
---|---|---|---|---|
|
Long |
- |
This value determines the application your flexfield, context, and segment belong to. |
Required |
|
String |
40 |
This value is the code of the extensible flexfield where you're adding your context segment. The value should match the code of an extensible flexfield that's already in the application. |
Required |
|
String |
80 |
This value is the code of the context where you're adding your segment. The value should match a context code that's in the application. |
Required |
|
String |
30 |
This value is the code for your segment. |
Required |
|
String |
60 |
This value is the name for your segment. |
Required |
|
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 |
|
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 |
|
String |
30 |
This value determines the display type of the segment. Here are the valid values for this attribute:
|
Required |
|
String |
80 |
This value determines the display name of the segment. |
Required |
|
String |
80 |
This value determines the shortened display name of the segment. |
Required |
|
String |
1 |
This value lets you enable or disable your segment:
|
Required |
|
String |
1 |
This value indicates whether you must specify the segment.
|
Required |
|
String |
1 |
This value lets you set your segment to be read-only.
|
Required |
|
String |
240 |
This value describes your segment. |
Optional |
|
String |
20 |
This value determines the unit for the data you add to your segment. |
Optional |
|
String |
80 |
This value provides a description for the segment. |
Optional |
|
String |
160 |
This value provides instructions on how to use the segment. |
Optional |
|
Integer |
- |
This value determines the order in which your segments are displayed in your context. |
Optional |
|
String |
30 |
This value specifies the type of default value for your segment. Here are
the types of default values:
|
Optional |
|
String |
4000 |
This value provides the default values for your segment. |
Optional |
|
Integer |
- |
This value specifies the maximum number of characters that display in a line. |
Optional |
|
Integer |
- |
This value specifies the maximum number of lines that display in the segment. |
Optional |
|
String |
30 |
This value determines the value of a selected check box in your segment. |
Required for display type |
|
String |
30 |
This value determines the value of a check box that's not selected in your segment. |
Required for display type |
|
String |
30 |
This value specifies the range of values for the low-end and high-end
fields. You can set the value as |
Optional |
|
String |
1 |
This value indicates whether your segment is BI enabled.
|
Optional |
|
String |
1 |
This value indicates whether the segment is marked as a unique key for
context with multiple rows.
At least one segment in a context with multiple rows must be marked as the unique key. |
Required for contexts with multiple rows |
|
String |
1 |
This value lets you display the value set description for the value set
associated with the segment:
|
Optional |
|
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 the context segment. You can see the header values at the beginning of the file, followed by the line entry of a context segment that's to be imported. For importing several context segments, add more entries in the same format.
ApplicationId|EFFCode|ContextCode|SegmentCode|Name|ColumnName|ValueSetCode|DisplayType|Prompt|ShortPrompt|EnabledFlag|RequiredFlag|ReadOnlyFlag|Description|UomClass
0|FLEX_SN_EFF1|ColdSourceTargetContext|Cold_TEST_SEG1|cold seg 1|ATTRIBUTE_CHAR3|EFF_BASIC_FMT_CHR|TEXT_BOX|Prompt|Short Prompt|Y|Y|N|TEST desc aug 14_3PM|