Skip to Main Content
Return to Navigation

Reviewing the External Survey Flat File Definitions

This section provides an overview of external survey flat file definitions and discusses how to:

Understanding External Survey Flat File Definitions

This section discusses the external survey flat file definitions that you use to work with your survey providers. Work with your providers to ensure that the survey data you receive from them fits the format specified in these file definitions. The end of this section provides lists of the valid values for selected fields in the file definitions that must use specified valid values.

Note: Wherever fields in the file definitions are designated as optional, Oracle recommends that you enter data in those fields. If you don't enter data in the optional fields, the system displays error messages when you run the ETL job sequencers, and data is not supplied in those fields in the data warehouse tables.

Reviewing the Author File Definition

The following table contains the Author flat file definition.

Note: You need the Author file when you have new author identification information. That is, you need it only when the survey provider data is new or has changed.

Field Name

Field Type / Length / Format

Valid Values

Required or Optional

Target Warehouse Tables

WA_AUTHOR_ID

Character / 10

 

R

WA_AUTHOR_R00.WA_AUTHOR_ID

EFFDT

Date / 8 / MMDDYYYY

 

R

WA_AUTHOR_R00.EFFDT

EFF_STATUS

Character / 1

Yes

R

WA_AUTHOR_R00.EFF_STATUS

ADDRESS1

Character / 35

 

R

WA_AUTHOR_R00.WA_ADDR_SBR

ADDRESS2

Character / 35

 

O

WA_AUTHOR_R00.WA_ADDR_SBR

ADDRESS3

Character / 35

 

O

WA_AUTHOR_R00.WA_ADDR_SBR

ADDRESS4

Character / 35

 

O

WA_AUTHOR_R00.WA_ADDR_SBR

CITY

Character / 30

 

R

WA_AUTHOR_R00.WA_ADDR_SBR

COUNTRY

Character / 3

 

R

WA_AUTHOR_R00.WA_ADDR_SBR

COUNTRY_CODE

Character / 3

Yes

R

WA_AUTHOR_R00.BUS_PHONE_SBR

DESCR

Character / 30

 

R

WA_AUTHOR_R00.DESCR

DESCRLONG

Long / 100

 

O

WA_AUTHOR_R00.DESCRLONG

EXTENSION

Character / 6

 

O

WA_AUTHOR_R00.BUS_PHONE_SBR

FAX

Character/ 24

 

O

WA_AUTHOR_R00.BUS_PHONE_SBR

PHONE

Character / 24

 

R

WA_AUTHOR_R00.BUS_PHONE_SBR

POSTAL

Character / 12

 

R

WA_AUTHOR_R00.WA_ADDR_SBR

STATE

Character / 6

 

R

WA_AUTHOR_R00.WA_ADDR_SBR

Image: Example row of Author file data in flat file format

The following example shows a single row of sample data, in comma delimited format, to help you create your author file.

Example row of Author file data in flat file format

Reviewing the Dimension File Definition

The following table contains the Dimension flat file definition. With respect to the last two columns, please note the following:

  • If WA_SUR_DIM_TYPE = C, then the target record is WA_SUR_COMP_D00.

  • If WA_SUR_DIM_TYPE = F, then the target record is WA_SUR_FIN_D00.

  • If WA_SUR_DIM_TYPE = G, then the target record is WA_SUR_GEO_D00.

  • If WA_SUR_DIM_TYPE = I, then the target record is WA_SUR_IND_D00.

  • If WA_SUR_DIM_TYPE = J, then the target record is WA_SUR_JOB_D00.

  • If WA_SUR_DIM_TYPE = U, then the target record is WA_SUR_UNIT_D00.

Note: You need the Dimension file when you have a new or changed dimension information. The WA_AUTHOR_ID in the Dimension file must be a valid author identification in the Author file definition.

Field Name

Field Type / Length / Format

Valid Values

Required or Optional

Target Warehouse Tables

Comments

WA_AUTHOR_ID

Character / 10

 

R

Target record is WA_AUTHOR_ID

WA_SUR_DIM_TYPE

Character / 1

Yes

R

Target record is *_CD

The '*' symbol could be G for Geography ID, J for Job Code, F for Financial Code, and so on.

WA_SUR_CODE

Character / 10

 

R

None

Driver for Target Record ETL mapping. These are the actual Geography, Compensation, Job Codes depending upon the WA_SUR_DIM_TYPE.

EFFDT

Date / 8 / MMDDYYYY

 

R

Target record is EFFDT

 

EFF_STATUS

Character / 1

Yes

R

Target record is EFF_STATUS

JOB_TYPE

Character / 1

Yes

R

Target record is FLSA_STATUS

Required only when type is J

WA_POINTS

Number / 3.0

 

R

Target record is WA_POINTS

Required only when type is J

WA_FROM_VALUE

Number / 15.0

 

R

Target record is WA_FROM_VALUE

Required only when type is F or U

WA_TO_VALUE

Number / 15.0

 

R

Target record is WA_TO_VALUE

Required only when type is F or U

DESCR

Character / 30

 

R

Target record is DESCR

 

DESCRLONG

Long / 100

 

R

Target record is DESCRLONG

Required only when type is J

Image: Example rows of Dimension file data in flat file format

The following example shows six rows of sample data, in comma delimited format, to help you create your Dimension file.

Example rows of Dimension file data in flat file format

Reviewing the Survey Instance File Definition

The following table contains the Survey Instance flat file definition.

Note: The Survey Instance file is required for a new survey instance with new survey data. The WA_AUTHOR_ID in this file must be a valid author identification in the Author file definition.

Field Name

Field Type/ Length/ Format

Valid Values

Required or Optional

Target Warehouse Tables

WA_SURVEY_ID

Character / 10

 

R

WA_SURVEY_R00.WA_SURVEY_ID

EFFDT

Date / 8 / MMDDYYYY

 

R

WA_SURVEY_R00.EFFDT

EFF_STATUS

Character / 1

Yes

R

WA_SURVEY_R00.EFF_STATUS

WA_AUTHOR_ID

Character / 10

 

R

WA_SURVEY_R00.WA_AUTHOR_ID

DESCR

Character / 30

 

R

WA_SURVEY_R00.DESCR

DESCRLONG

Long / 100

 

N

WA_SURVEY_R00.DESCRLONG

WA_PUBLICATION_DT

Date / 8

 

R

WA_SURVEY_R00.WA_PUBLICATION_ID

WA_SUR_CO_COUNT

Number / 8.0

 

R

WA_SURVEY_R00.WA_SUR_CO_COUNT

WA_SUR_EE_COUNT

Number / 8.0

 

R

WA_SURVEY_R00.WA_SUR_EE_COUNT

CURRENCY_CD

Character / 3.0

Yes

R

Note. This field is not mapped directly to the WA_SURVEY_R00 table. The ETL job uses the currency code as join condition to determine all of the setIDs from the WA_SET_CUR_VW with the given currency code. Then those setIDs are inserted in the WA_SURVEY_R00 table.

Image: Example row of Survey Instance data in flat file format

The following example shows a single row of sample data, in comma delimited format, to help you create your Survey Instance file.

Example row of Survey Instance data in flat file format

Reviewing the Compensation Survey File Definition

The following table contains the Compensation Survey flat file definition.

Note: For the WA_SURVALUE_F00.WA_MEASURE_ID field, you should use the EPM Measure IDs that are delivered with the system. To add more requires modifications to the system. Also, note that the WA_SURVALUE_F00.WA_MEASURE_VAL field is for the actual monetary value of the measure, not the ID code.

Field Name

Field Type / Length/ Format

Valid Values

Required or Optional

Target Warehouse Tables

WA_SURVEY_ID

Character / 10

 

R

WA_IND_MAP_DFN.WA_SURVEY_ID WA_FIN_MAP_DFN.WA_SURVEY_ID WA_UNIT_MAP_DFN.WA_SURVEY_ID WA_JOB_MAP_DFN.WA_SURVEY_ID WA_COMP_MAP_DFN.WA_SURVEY_ID WA_GEO_MAP_DFN.WA_SURVEY_ID WA_SURVALUE_F00.WA_SURVEY_ID (ETL2)

WA_SUR_JOBCODE

Character / 10

 

R

WA_JOB_MAP_DFN.WA_SUR_JOBCODE

WA_SUR_COMPCODE

Character / 10

 

R

WA_COMP_MAP_DFN.WA_SUR_COMPCODE

WA_SUR_GEO_ID

Character / 10

 

R

WA_GEO_MAP_DFN.WA_SUR_GEO_ID

WA_SUR_IND_ID

Character / 10

 

R

WA_IND_MAP_DFN.WA_SUR_IND_ID

WA_SUR_FINCODE

Character / 10

 

R

WA_FIN_MAP_DFN.WA_SUR_FINCODE

WA_SUR_UNITCODE

Character / 10

 

R

WA_UNIT_MAP_DFN.WA_SUR_UNITCODE

EFFDT

Date / 8 / MMDDYYYY

 

R

WA_SURVALUE_F00.EFFDT

COMP_FREQUENCY

Character / 1

Yes

R

WA_SURVALUE_F00.COMP_FREQUENCY

WA_MEASURE_ID

Character / 3

Yes

R

WA_SURVALUE_F00.WA_MEASURE_ID

WA_MEASURE_VAL

Number / 15.6

 

R

WA_SURVALUE_F00.WA_MEASURE_VAL

CURRENCY_CD

Character / 3

Yes

R

WA_SURVALUE_F00.CURRENCY_CD

WA_UNITS

Character / 1

Yes

R

ETL uses this to determine whether value conversion is required.

WA_SAMPLE_CO_COUNT

Number / 8.0

 

R

WA_SURVALUE_F00.WA_SAMPLE_CO_COUNT

WA_SAMPLE_EE_COUNT

Number / 8.0

 

R

WA_SURVALUE_F00.WA_SAMPLE_EE_COUNT

Image: Example rows of Compensation Survey data in flat file format

The following example shows six rows of sample data, in comma delimited format, to help you create your Compensation Survey file.

Example rows of Compensation Survey data in flat file format

Reviewing the Benchmark Survey File Definition

The following table contains the Benchmark Survey flat file definition.

Note: For the WA_BENCHMRK_F00.PF_METRIC_ID field, you should use the EPM measure IDs that are delivered with the system. To add more requires modifications to the system. Also, note that the WA_BENCHMRK_F00.WA_MEASURE_VAL field is for the actual value of the metric, not the ID code.

Field Name

Field Type/ Len./ Format

Valid Value

Required or Optional

ETL

Target Warehouse Tables

WA_SURVEY_ID

Character / 10

 

R

1,2

WA_IND_MAP_DFN.WA_SURVEY_ID WA_FIN_MAP_DFN.WA_SURVEY_ID WA_UNIT_MAP_DFN.WA_SURVEY_ID WA_GEO_MAP_DFN.WA_SURVEY_ID WA_BENCHMRK_F00.WA_SURVEY_ID (ETL2)

WA_SUR_GEO_ID

Character / 10

 

R

1

WA_GEO_MAP_DFN.WA_SUR_GEO_ID

WA_SUR_IND_ID

Character / 10

 

R

1

WA_IND_MAP_DFN.WA_SUR_IND_ID

WA_SUR_FINCODE

Character / 10

 

R

1

WA_FIN_MAP_DFN.WA_SUR_FINCODE

WA_SUR_UNITCODE

Character / 10

 

R

1

WA_UNIT_MAP_DFN.WA_SUR_UNITCODE

EFFDT

Date / 8 / MMDDYYYY

 

R

2

WA_BENCHMRK_F00.EFFDT

PF_METRIC_ID

Character / 3

Yes

R

2

WA_BENCHMRK_F00.PF_METRIC_ID

WA_MEASURE_VAL

Number / 15.6

 

R

2

WA_BENCHMRK_F00.WA_MEASURE_VAL

CURRENCY_CD

Character / 3

Yes

R

2

WA_BENCHMRK_F00.CURRENCY_CD

WA_UNITS

Character / 1

Yes

R

2

ETL uses this to determine whether conversion of value is required.

WA_SAMPLE_CO_COUNT

Number / 8.0

 

R

2

WA_BENCHMRK_F00.WA_SAMPLE_CO_COUNT

WA_SAMPLE_EE_COUNT

Number / 8.0

 

R

2

WA_BENCHMRK_F00.WA_SAMPLE_EE_COUNT

Image: Example rows of Benchmark Survey data in flat file format

The following example shows six rows of sample data, in comma delimited format, to help you create your Benchmark Survey file.

Example rows of Benchmark Survey data in flat file format

Reviewing the Employee Survey File Definition

The following table contains the Employee Survey flat file definition.

Field Name

Field Type / Length/ Format

Valid Values

Required or Optional

Target Warehouse Tables

WA_SURVEY_ID

Character / 10

 

R

WA_EESURVEY_F00.WA_SURVEY_ID

EFFDT

Date / 8 / MMDDYYYY

 

R

WA_EESURVEY_F00.EFFDT

EFF_STATUS

Character / 1

Yes

R

WA_EESURVEY_F00.EFF_STATUS

WA_RM_FACTOR_ID

Character / 10

 

R

WA_EESURVEY_F00.WA_RM_FACTOR_ID

PF_OBJ_ID

Character / 20

 

R

WA_EESURVEY_F00.PF_OBJ_ID

PF_OBJ_TYPE

Character / 4

Yes

R

WA_EESURVEY_F00.PF_OBJ_TYPE

WA_FACTOR_WEIGHT

Number / 5.0

 

R

WA_EESURVEY_F00.WA_FACTOR_WEIGHT

WA_SAMPLE_EE_COUNT

Number / 8.0

 

R

WA_EESURVEY_F00.WA_SAMPLE_EE_COUNT

Reviewing the Valid Values for Selected Fields in the File Definitions

The following tables in this section provide lists of the valid values for selected fields in the file definitions that must use specified valid values.

Effective Status

EFF_STATUS Valid Values

A = Active

I = Inactive

Country Code

Valid values are any of the country codes in COUNTRY_TBL.

Survey Dimension Type

WA_SUR_DIM_TYPE Valid Values

C = Compensation

F = Financials

G = Geography

I = Industry

J = Job

U = Unit

Job Type

JOB_TYPE Valid Values

A = Administrative

E = Executive

M = Management

N = Nonexempt

O = Outside Salesperson

P = Professional

X = None

Currency Code

Valid values are any currency code in the CURRENCY_CD_TBL.

Compensation Frequency

COMP_FREQUENCY Valid Values

A = Annual

B = Biweekly

D = Daily

H = Hourly

M = Monthly

S = Semimonthly

W = Weekly

Note: HCM Warehouse Workforce Insight analysis templates, as delivered, are set up to use compensation-frequency values of Annual only. Modification is needed if you want your analysis templates to use any other compensation frequency values.

Units

WA_UNITS Valid Values

1 = Ones

2 = Hundreds

3 = Thousands

4 = 10 Thousands

5 = 100 Thousands

6 = Millions

7 = 10 Millions

8 = 100 Millions

9 = Billions

Object Type

PF_OBJ_TYPE Valid Values

1000 = Employee

2000 = Department

2100 = Business Unit

9000 = Job Code

Measure ID and Metric ID Codes

WA_MEASURE_ID / PF_METRIC_ID Valid Values

Description

Survey Type

001

Y-Intercept- Natural

Compensation Survey

002

Slope- Natural

Compensation Survey

003

Standard Error

Compensation Survey

004

R-Squared

Compensation Survey

005

Actual 10th Percentile Amount

Compensation Survey

006

Actual 20th Percentile Amount

Compensation Survey

007

Actual 25th Percentile Amount

Compensation Survey

008

Actual 30th Percentile Amount

Compensation Survey

009

Actual 40th Percentile Amount

Compensation Survey

010

Actual 50th Percentile Amount

Compensation Survey

011

Actual 60th Percentile Amount

Compensation Survey

012

Actual 70th Percentile Amount

Compensation Survey

013

Actual 75th Percentile Amount

Compensation Survey

014

Actual 80th Percentile Amount

Compensation Survey

015

Actual 90th Percentile Amount

Compensation Survey

016

Actual Average Amount

Compensation Survey

017

Actual 10th Percentile Percent

Compensation Survey

018

Actual 20th Percentile Percent

Compensation Survey

019

Actual 25th Percentile Percent

Compensation Survey

020

Actual 30th Percentile Percent

Compensation Survey

021

Actual 40th Percentile Percent

Compensation Survey

022

Actual 50th Percentile Percent

Compensation Survey

023

Actual 60th Percentile Percent

Compensation Survey

024

Actual 70th Percentile Percent

Compensation Survey

025

Actual 75th Percentile Percent

Compensation Survey

026

Actual 80th Percentile Percent

Compensation Survey

027

Actual 90th Percentile Percent

Compensation Survey

028

Actual Average Percent

Compensation Survey

029

Actual % of Eligible Employees

Compensation Survey

030

Target 10th Percentile Amount

Compensation Survey

031

Target 20th Percentile Amount

Compensation Survey

032

Target 25th Percentile Amount

Compensation Survey

033

Target 30th Percentile Amount

Compensation Survey

034

Target 40th Percentile Amount

Compensation Survey

035

Target 50th Percentile Amount

Compensation Survey

036

Target 60th Percentile Amount

Compensation Survey

037

Target 70th Percentile Amount

Compensation Survey

038

Target 75th Percentile Amount

Compensation Survey

039

Target 80th Percentile Amount

Compensation Survey

040

Target 90th Percentile Amount

Compensation Survey

041

Target Average Amount

Compensation Survey

042

Target 10th Percentile Percent

Compensation Survey

043

Target 20th Percentile Percent

Compensation Survey

044

Target 25th Percentile Percent

Compensation Survey

045

Target 30th Percentile Percent

Compensation Survey

046

Target 40th Percentile Percent

Compensation Survey

047

Target 50th Percentile Percent

Compensation Survey

048

Target 60th Percentile Percent

Compensation Survey

049

Target 70th Percentile Percent

Compensation Survey

050

Target 75th Percentile Percent

Compensation Survey

051

Target 80th Percentile Percent

Compensation Survey

052

Target 90th Percentile Percent

Compensation Survey

053

Target Average Percent

Compensation Survey

054

Target % of Eligible Employees

Compensation Survey

055

Y-Intercept- Common

Compensation Survey

056

Slope- Common

Compensation Survey

057

R

Compensation Survey

058

Standard Error- Logarithmic

Compensation Survey

100

Productivity Factor

Benchmark Survey

101

Efficiency Factor

Benchmark Survey

102

Effectiveness Factor

Benchmark Survey

103

Employee Compensation Return on Investment (ROI)

Benchmark Survey

104

Workforce Compensation ROI

Benchmark Survey

105

Employee Workforce ROI

Benchmark Survey

106

Contingent Workforce ROI

Benchmark Survey

107

Total Compensation Revenue Ratio

Benchmark Survey

108

Cash Compensation Revenue Ratio

Benchmark Survey

109

Benefits Revenue Ratio

Benchmark Survey

110

Total Compensation Expenses Ratio

Benchmark Survey

111

Cash Compensation Expenses Ratio

Benchmark Survey

112

Benefits Expenses Ratio

Benchmark Survey

113

Executive Ratio

Benchmark Survey

114

Supervisory Ratio

Benchmark Survey

115

Executive Compensation Ratio

Benchmark Survey

116

Supervisory Compensation Ratio

Benchmark Survey

117

Executive Compensation Factor

Benchmark Survey

118

Supervisory Compensation Factor

Benchmark Survey

119

Employee Compensation Factor

Benchmark Survey

120

Contingency Workforce Ratio

Benchmark Survey

121

Contingency Revenue Ratio

Benchmark Survey

122

Contingency Expenses Percent

Benchmark Survey

123

Contingency Expenses Ratio

Benchmark Survey

124

Total Labor Cost Revenue Ratio

Benchmark Survey

125

Total Labor Cost Expense Ratio

Benchmark Survey

126

Transfer Ratio

Benchmark Survey

127

Promotion Ratio

Benchmark Survey

128

Hire Ratio

Benchmark Survey

129

Exempt Hire Ratio

Benchmark Survey

130

Non-Exempt Hire Ratio

Benchmark Survey

131

Increase Hire Ratio

Benchmark Survey

132

Replacement Hire Ratio

Benchmark Survey

133

Separation Ratio

Benchmark Survey

134

Exempt Separation Ratio

Benchmark Survey

135

Non-Exempt Separation Ratio

Benchmark Survey

136

Open Position Ratio

Benchmark Survey

137

Staffing- Hire Ratio

Benchmark Survey

138

Staffing- Exempt Hire Ratio

Benchmark Survey

139

Staffing- Non-Exempt Hire Ratio

Benchmark Survey

140

Staffing- Increase Hire Ratio

Benchmark Survey

141

Staffing- Replacement Hire Ratio

Benchmark Survey

142

Staffing- Open Position Ratio

Benchmark Survey

143

Time to Fill Factor

Benchmark Survey

144

Exempt Time to Fill Factor

Benchmark Survey

145

Non-Exempt Time to Fill Factor

Benchmark Survey

146

Hire to Separation Ratio

Benchmark Survey

147

Hiring Expenses Factor

Benchmark Survey

148

Exempt Hiring Expenses Factor

Benchmark Survey

149

Non-Exempt Hiring Expenses Factor

Benchmark Survey

150

Hiring Expenses Ratio

Benchmark Survey

151

Tenure Profile

Benchmark Survey

152

Exempt Tenure Profile <=1 Year

Benchmark Survey

153

Exempt Tenure Profile <=3 Years

Benchmark Survey

154

Exempt Tenure Profile <=5 Years

Benchmark Survey

155

Exempt Tenure Profile <=10 Years

Benchmark Survey

156

Exempt Tenure Profile >10 Years

Benchmark Survey

157

Non-Exempt Tenure <=1 Year

Benchmark Survey

158

Non-Exempt Tenure <=3 Years

Benchmark Survey

159

Non-Exempt Tenure <=5 Years

Benchmark Survey

160

Non-Exempt Tenure <=10 Years

Benchmark Survey

161

Non-Exempt Tenure >10 Years

Benchmark Survey

162

Voluntary Separation Tenure <=1 Year

Benchmark Survey

163

Voluntary Separation Tenure <=3 Years

Benchmark Survey

164

Voluntary Separation Tenure <=5 Years

Benchmark Survey

165

Voluntary Separation Tenure <=10 Years

Benchmark Survey

166

Voluntary Separation Tenure >10 Years

Benchmark Survey

167

Exempt Voluntary Separation Tenure <= 1 Year

Benchmark Survey

168

Exempt Voluntary Separation Tenure <= 3 Years

Benchmark Survey

169

Exempt Voluntary Separation Tenure <= 5 Years

Benchmark Survey

170

Exempt Voluntary Separation Tenure <=10 Years

Benchmark Survey

171

Exempt Voluntary Separation Tenure >10 Years

Benchmark Survey

172

Non-Exempt Voluntary Separation Tenure <=1 Year

Benchmark Survey

173

Non-Exempt Voluntary Separation Tenure <=3 Years

Benchmark Survey

174

Non-Exempt Voluntary Separation Tenure <=5 Years

Benchmark Survey

175

Non-Exempt Voluntary Separation Tenure <=10 Years

Benchmark Survey

176

Non-Exempt Voluntary Separation Tenure >10 Years

Benchmark Survey

178

Involuntary Separation Ratio

Benchmark Survey

179

Voluntary Separation Ratio

Benchmark Survey

180

Exempt Separation Ratio

Benchmark Survey

181

Exempt Involuntary Separation Ratio

Benchmark Survey

182

Exempt Voluntary Separation Ratio

Benchmark Survey

183

Non-Exempt Separation Ratio

Benchmark Survey

184

Non-Exempt Involuntary Separation Ratio

Benchmark Survey

185

Non-Exempt Voluntary Separation Ratio

Benchmark Survey

186

Employee Lost Time Factor

Benchmark Survey

187

FTE Lost Time Factor

Benchmark Survey

188

Workers' Compensation Expenses Ratio

Benchmark Survey

189

Employee Workers' Compensation Factor

Benchmark Survey

190

Workforce Workers' Compensation Factor

Benchmark Survey

191

HR Readiness- Support Ratio

Benchmark Survey

192

Exempt Ratio

Benchmark Survey

193

Investment Factor

Benchmark Survey

194

HR Readiness- Expenses Ratio

Benchmark Survey

195

Employee Investment Factor

Benchmark Survey

196

Trained Employee Investment

Benchmark Survey

197

Training- Expenses Ratio

Benchmark Survey

198

Training- Support Ratio

Benchmark Survey

199

Healthcare Factor

Benchmark Survey

200

Benefits Compensation Expenses Ratio

Benchmark Survey