button next to the Export Name field to
find, add, modify, copy, or delete an Export Name. See Export
for more information.The Export Field tab on the Export Definition form is used to configure the Header, Detail, and Trailer sections of your export output file. The Field Function tab is used to format the output of a field in the export file.
Note: You cannot use the same Field Name in multiple sections of the export file (Header, Detail, and Trailer). The Field Name must be unique in each section.
See Also:
Export Field Tab - Field Descriptions
Change the Order of the Export Fields
Export Name
Defines the export instance that you will run from the
Exports form. Click the button next to the Export Name field to
find, add, modify, copy, or delete an Export Name. See Export
for more information.
Record Type
You can configure the Header, Detail, and Trailer sections of your export output file. When you add, modify, or delete an export field, you first need to select the Record Type from the top of this tab. The fields that display on the Export Field tab will be for a particular Record Type.
Record Type |
Description |
Header |
A header is a line of data displayed at the top of the output data file. You can configure the header to display in three different ways:
|
Detail |
A detail record is used to configure the data that will be exported. One record equals one column in the export. |
Trailer |
A trailer is a line of data displayed at the bottom of the output data file. You can configure the trailer to display in six different ways:
|
Field Name
The identifying name of this record. The Field Name is used as the name for the Header/Trailer records when the Record Type is Static.
You cannot use the same Field Name in multiple sections of the export file (Header, Detail, and Trailer). The Field Name must be unique in each section.
Description
A description of the record.
Sequence Number
Each field in the record will have a unique sequence number that will define the position/order of the field in the record. No duplicate sequence numbers are allowed for a record layout. The first record you add is number 1. That is the record located on the far left in the output file. You can change the sequence order by using the Move Up/Move Down buttons.
Start Position
Start position is only applicable for fixed length layouts. It defines where each field starts in the record layout.
End Position
End position is only applicable for fixed length layouts. It defines where each field ends in the record layout.
Field Length
Field Length is only applicable for fixed length layouts. Identifies the length of the field.
Group By
The Group By check box is only available for Payroll exports. It is used to group field values of equal value. If this box is checked, then the system will group same values into one row in the output.
Depends on Field
Used to determine if the current field can have a value. At run time the system will evaluate the dependent field. If the field value is not empty, then the current field will display.
Data Type
The Data Type identifies the type of data that is displayed.
Data Type |
Description |
String |
The value is a fixed value. |
Time |
The value is a timestamp. |
Date |
The value is expressed as MM-DD-YYYY. |
Date Time |
The value shows the date and time. |
Integer |
A numeric value. |
Seconds |
The value is expressed in seconds. |
Hours |
The value is expressed in hours. |
Decimal |
The value is expressed with decimal points. |
Show in Output
The Show in Output check box determines if the field will display in the output data. This is useful if you have configured several Export Definitions for an Export Name but don't always want to include all the fields when you run the export. Instead of deleting the fields, you can un-check the Show in Output box.
Field Source
The Field Source determines where the data for the record comes from. The available options depend on whether you are defining a header, detail, or trailer record.
Field Source |
Available for Record Type |
Description |
Action Prompt |
Detail |
This option is available when the Export Context is Action. The field's value will come from an event prompt with the Std Validation ID "Insert Action Process Status to Export Action Record(s)." See Event Validation for more information.
|
Count |
Trailer |
The system will count how many records are listed in the column specified in the Field Value field.
|
Count Distinct |
Trailer |
The system will count how many different records are listed in the column specified in the Field Value field.
|
Generated Value |
Header and Trailer |
The system will populate the field with the Field Value (CURRENT_DATE or FILE_NAME).
|
Rule |
Detail |
The system will extract data from system tables according to the Export Rule selected in the Field Value field. Export Rules are defined on the Calc Rule form
|
Ruleset |
Detail |
The system will extract data from system tables according to the Export Ruleset selected in the Field Value field. Export Rulesets are defined on the Rulesets form with the Context Name ExportRuleset.
|
Static |
Header and Trailer |
A set value - the Field Value is used as the value.
|
Sum |
Trailer |
The system will sum the value of the records in the column specified in the Field Value field.
|
Table |
Detail |
Identifies that the value should be extracted from a system table.
|
User Field |
Header, Detail, and Trailer |
If you select User Field and leave the Field Value empty, the header/trailer displays as an empty text box in the filter area of the Export form. Whichever value the user enters in the text box at the time of the export will display as the header/trailer. To use this setting, select User Field as the Source Field when adding the header record. If you select User Field and enter comma separated valid values in the Field Value field, the header/trailer will display as a drop-down menu in the filter area of the Export form. Whichever value the user selects at the time of the export will display as the header/trailer. To use this setting, select User Field as the Field Source and enter the comma separated valid values in the Field Value field when adding the record.
|
Field Value
If the Field Source requires a field value, it is entered or selected here.
Field Source |
Field Value |
Action Prompt |
The Field Value is a drop-down menu of event prompts. The available event prompts are for an event with an Event Validation record that has the Std Validation ID "Insert Action Process Status to Export Action Record(s)." See Event Validation for more information.
|
Count |
Select the column for which you want to provide a count of the number of records. The available options are determined by the Detail records in your export.
|
Distinct Count |
Select the column for which you want to provide a count of the number of different records. The available options are determined by the Detail records in your export.
|
Generated Value |
Select CURRENT_DATE to place the current date in this export field. Select FILE_NAME to place the name of the output file in this export field.
|
Rule |
Select the Export Rule that will be used to calculate this field's value. If you only want the output to show certain values, enter these values in the Output Valid Values field. The values must be comma separated. For example: R,O, OVT,12. Note: Rules are created on the Calc Rule form.
|
Ruleset |
Select the Export Ruleset that will be used to calculate this field's value. If you want to limit the output to show only certain values, enter the valid values in the Output Valid Values field. The values must be comma separated. For example: R,O, OVT,12. Note: Rulesets are created on the Rulesets form.
|
Static |
Enter a constant value in the Field Value field.
|
Table |
Select the table column that will be used to determine this field's value. The available table columns will depend on the Context Name of your export. For example, if your Context Name is “Person,” then the Field Value list will contain columns from the person tables. If your Context Name is “Charge Element,” then the Field Value list will contain table columns related to charge elements.
|
User Field |
If the Field Value is left blank, a text box will display on the Exports form so the user can input the value. If you want this field to display options, enter the comma separated values in the Field Value field. The user can make the selection from this list.
|
Output Valid Values
This field is available when your Field Source is Rule or Ruleset.
Valid values are used to limit the records available in the output. Values must be separated by a comma.
If your export has Enable Audit checked, you need to use the Output Data Map field to specify the column in the export_output_data_map table where the field will be mapped. Data in the export_output_data_map table can be accessed by an Ad Hoc Report with the Export Audit context.
For example, a Payroll Export includes the fields Person Number, First Name, Last Name, Duration, Payroll Amount, and Payroll Rate. The Output Data Map field maps each field to the corresponding column in the export_output_data_map table. Enable Audit is also checked for the Payroll Export. At the end of the month, an administrator runs an Ad Hoc Report (with the Export Audit context) to check the Payroll Amounts for a specific employee. The report selects records from the export_output_data_map table.
Available options for the Output Data Map field are the columns in the export_output_data_map table.
The Duration column in the export_output_data_map table should only be used for a transaction's duration amount. If you map any value other than a transaction's duration to the Duration column, the value may not display correctly.
The columns listed below are stored as raw data in the export_output_data_map table and will not be formatted according to the Field Function settings. The data will be formatted correctly in the export file, but will not be formatted in the export_output_data_map table.
payroll_rate |
create_date |
labor_rate |
pay_date |
duration |
posting_date |
If you need to store this data with formatted values in the export_output_data_map table, you should map to one of the Adhoc Value fields instead.
Click Main Menu > Configuration > Interfaces > Export Definition.
Find the Export Name to which you want to add a header/detail/trailer record.
Go to the Export Field tab.
Select the Record Type (Header, Detail, or Trailer).
Click Find. The existing export field records (if any) appear in the grid.
Click Add.
Enter a Field Name.
Enter a Description.
If the Export Name is for a Fixed Length Format, specify a Start Position of the data and the Field Length.
Check the Group By box to group field values of equal value. If this box is checked, then the system will group same values into one row in the output file.
Depends On Field is used to determine if the current field can have a value. At run time the system will evaluate the dependent field. If the field value is not empty, then the current field will display.
Select a Data Type.
Keep the Show in Output box checked if you want this field to display in the filter area of the Exports form. It will allow you to filter the Export records.
Select a Field Source and, if necessary, a Field Value.
If your export has Enable Audit checked, you will need to use the Output Data Map field to select the column in the export_output_data_map table to which the field will be mapped.
Click Save when you are finished.
If you want to add more than one Export Field, click Save and Add to save your settings and keep the Add window open. Or click Save to save your Export Field and return to the main form.
Click Main Menu > Configuration > Interfaces > Export Definition.
Find the Export Name for which you want to modify a header/detail/trailer record.
Go to the Export Field tab.
Select the Record Type you want to modify (Header, Detail, or Trailer).
Click Find. The Export Field records appear in the grid.
Select the export field record you want to change and click Modify.
Modify the record and click Save.
Click Main Menu > Configuration > Interfaces > Export Definition.
Find the Export Name from which you want to delete a header/detail/trailer record.
Go to the Export Field tab.
Select the Record Type you want to delete (Header, Detail, or Trailer).
Click Find. The Export Field records appear in the grid.
Select the export field record you want to delete and click Delete.
Click OK to confirm the action.
Click Main Menu > Configuration > Interfaces > Export Definition.
Find the Export Name to which you want to add a header/detail/trailer record.
Go to the Export Field tab.
Select the Record Type of the fields you want to reorder (Header, Detail, or Trailer).
Click Find. The Export Field records appear in the grid.
Select an Export Field record and click the Move Up or Move Down button at the top of the form.
Repeat step 6 for any other fields you want to reorder.