button
next to the Export Name field
on the Export Definition form. Choose
Add, Lookup, or Maintain.The Export form is used to create Export Names that can be configured on the Export Definition form.
To open this form, click the button
next to the Export Name field
on the Export Definition form. Choose
Add, Lookup, or Maintain.
The application comes with several pre-defined exports (OUT_EBS_WIP_COST, OUT_EBS_PA_TRANSACTION, SAP_CONF21, etc.). These exports cannot be deleted or modified. However, you can copy a System Required export and then modify it as necessary.
See Also:
Export Name Field Descriptions
The Context identifies the record's function and indicates what type of data extraction is being performed. Each Context is limited to a set of tables from which the data can be extracted.
Action: Action data extraction allows you to export/re-export data for specific actions (events). The event must be configured with Event Validation via the Events form. The data is converted according to the output requirements in the Export Definition.
Charge_Element: A Charge Element export allows you to export charge elements, such as order numbers, operation numbers, projects, and account numbers. On the Export Parameters tab, you can specify the Charge Types and Element Names you want to export. These options are defined on the Charge Type form.
Labor: Labor data extraction allows you to export/re-export employee labor data. You can specify which charge types and facilities you want to export, as well as the events you want to export. The data is converted according to the output requirements in the Export Definition.
The Labor Export Context can also be used to define a Labor Distribution Export . To do so, set the PROCESS_NAME in the Export Parameters to "Labor Distribution."
Message: Use this context to export messages and their responses to an external system.
Payroll: Payroll Data extraction allows you to export/re-export data for a specific payroll period. The data is converted according to the output requirements in the Export Definition.
Person (Employee): A Person export will extract data from the person table (such as badge numbers, employee profiles, assignments, and ad hoc codes). This information can be found on the Employee form.
Person_Balance: A Person Balance export will extract data about a person’s balances (leave type code, balance value, carry over value, etc.)
Person_Info: A Person_Info export will extract data from the person_info table, which is a table that stores person data received from an ERP system.
Person_Pin: This context will export person numbers and their corresponding PINS from the person table. You can use the DAYS_TO_EXPORT parameter to customize this list.
Person_Period: Sends employee timecard approval (signed timecard) data. A system-defined Export Definition called LDMTIME_APPROVAL has the Person_Period Export Context.
Transaction: Sends employee timecard data. There are three system-defined Export Definitions that have the Transaction Export Context:
LDMTIME: Sends employee timecard data (employee information, post date, charge elements, and hours).
PCMCOMP: Sends order completion quantities (order number, operation number, operation step, and completed quantity).
PCMINSP: Sends the quantity captured during inspection (order number, operation number, operation step, quantity accepted/rejected/scrapped, reject disposition/reason, and report ID).
Export Name
A unique identifier for the record.
Export Type
Determines the output format for the data.
CSV: The data will be exported using the CSV (comma separated values) format. If your Export Destination is FILE, the data columns will not have a header.
CSV With Header: The data will be exported using the CSV (comma separated values) format. If your Export Destination is FILE, each column will have a header that corresponds to a Field Name in the export (e.g., Person Number, First Name, Last Name).
Fixed Length: The data will be exported using the fixed length format. Each field in the export will have a fixed start and end position. If your Export Destination is FILE, the data columns will not have a header.
JSON: The data will be exported using the JSON (JavaScript Object Notation) format.
BCOREXML: The data will be exported to an XML file.
TABLE: The data will be exported to a table.
XML: The data will be exported to an XML file that will be used to send data to an ERP system. Use this option to produce an XML file that is specific to the ERP XML format.
Use this setting to configure where you want the export data to be sent.
QUEUE: Select QUEUE as your Export Destination if you want the export data to be placed in the Interface Out Queue (interface_out_queue table). The transaction_data column will contain the export data in the format of the Export Type you selected (CSV, Fixed Length, etc.). You can use the OUT_FILE_WRITER service to convert the data in the Interface Out Queue to an XML file.
You cannot select QUEUE as your Export Destination if the Export Type is TABLE.
If you want to export data to the queue, you also need to:
Use an instance of the EXPORT or PAYROLL_EXPORT service to run the export. The Exports form (Main Menu > Payroll > Exports) cannot export to the queue. An error message will display if the destination is QUEUE and you try to run the export from the Exports form.
Enable the OUT_CONVERT or OUT_CONVERT_TEXT task of the EXPORT or PAYROLL_EXPORT service. If the Export Type is BCOREXML or XML, enable the OUT_CONVERT task. If the Export Type is CSV, CSV With Header, Fixed Length, or JSON, enable the OUT_CONVERT_TEXT task.
Configure the INTERFACE_NAME, TRANSACTION_NAME, SENDER_NAME, and RECEIVER_NAME parameters for the service.
FILE: Select FILE as your Export Destination if you want the export data to be saved in a file. You must also enter a File Name (see below). You can also change the Destination Folder where the file will be saved.
You cannot select FILE as your Export Destination if the Export Type is TABLE.
TABLE: Select TABLE as your Export Destination if you are exporting the data to a table. This Export Destination is only available if your Export Type is TABLE. You will also need to configure the table on the Export Record tab.
Destination Folder
Identifies the output file's location. The default location is the \export folder in your AUTOTIME_HOME folder.
Identifies the output file name. If the Export Destination is FILE, you must enter a File Name.
You can use the following semantics in your File Name to include the timestamp and the Export Output ID number on the File Name. These semantics will cause a unique file to be generated each time you run the export.
[%TS%] |
Include this semantic to add the current timestamp to the file name. The timestamp format will be yyyyMMddHHMMSS. For example, if the File Name is Action_Export_[%TS%] and the export file is generated on July 31, 2018 at 12:08:32 p.m., the export file name will be named Action_Export_20180731120832. |
[%ID%] |
Include this semantic to add the Export Output ID number (a system-assigned ID number for the export) to the file name. For example, if the File Name is Action_Export_[%ID%], the export file that is generated will be named Action_Export_1000. The next time you generate this export, the file will be named Action_Export_1001. |
The [%TS%] and [%ID%] semantics can be placed anywhere in the file name (e.g., [%TS%]_Action_Export or Action_Export_[%TS%]).
Override File
If a file with the same name already exists in the destination folder, the Override File setting determines if the existing file will be overwritten.
Append: New values will be added to the existing file.
Prevent: A new file will not be created. An error message will display in the Error Log in which the existing file name will be identified.
Delete: The existing file will be deleted and replaced with the new file.
Ruleset Name
This field applies only if the Export Context Name is Payroll or Labor.
Identifies which Export Ruleset is used for this record. Export Rulesets determine when and how timecard data is grouped and extracted from the system tables.
Split Premium
Note: This field applies only if the Export Context Name is Payroll or Labor.
The split premium value determines if premium portions of a transaction will display in a separate record. Note that the time reporter's Export Premium Policy must be configured with at least a BASE record type in order for the Split Premium setting to take effect. See Export Premium Policy for more details.
No Split: There will be a single record combining base, hours premium, and shift premium. Note: This setting requires a configured BASE record type in the time reporter's Export Premium Policy.
Split Shift Premium: There will be one record for the base and hours premium portions and a separate record for the shift premium portion. Note: This setting requires configured BASE and SHIFT PREMIUM record types in the time reporter's Export Premium Policy.
Split Hours Premium and Shift Premium: There will separate records for base, hours premium, and shift premium. Note: This setting requires configured BASE, HOURS PREMIUM, and SHIFT PREMIUM record types in the time reporter's Export Premium Policy.
Emp Sign Required
This option is only available when the Export Context is Payroll.
When this box is checked, a person's records will only be exported if all the days in the range have employee signatures.
Sup Sign Required
This option is only available when the Export Context is Payroll.
When this box is checked, a person's records will only be exported if all the days in the range have supervisor signatures.
Payroll Lock Required
This option is only available when the Export Context is Labor, Payroll, or Transaction.
If Payroll Lock Required is checked and the export finds a day that is not payroll locked for a particular employee, the export will be affected as follows:
Labor Export: If a day is not payroll locked for a particular employee, that day will not be exported.
Labor Distribution Export: If a day is not payroll locked for a particular employee, the entire export will stop. No employees will be exported for that pay period.
Payroll Export: If a day is not payroll locked for a particular employee, that employee will not be exported for that pay period.
This setting determines whether the export data will be placed in the export audit tables (export_output_data and export_output_data_map).
You can use the records in the export_output_data table to compare the export files Shop Floor Time sent with the data that your ERP or payroll system received. The columns in the export_output_data_map table are available to the user through the Export Audit context of an Ad Hoc Report. You need to map the export data to a column in the export_output_data_map table by configuring the Output Data Map field on the Export Field form.
If Enable Audit is checked and the export runs from a service instance, the export data will be placed in the export_output_data and export_output_data_map tables, provided the fields are mapped.
If Enable Audit is not checked and the export runs from a service instance, the export data will not be placed in the export_output_data or the export_output_data_map table.
When you run an export from the Exports form (Main Menu > Payroll > Exports), the export data will always be placed in the export_output_data table, regardless of the Enable Audit setting. You must check the Enable Audit box if you want the data placed in the export_output_data_map table as well (provided the fields are mapped as explained above).
Example 1: A Labor Export runs from an instance of the EXPORT service. If Enable Audit is checked, the entire export file is placed in the output_data column of the export_output_data table. The export file data is also mapped to columns such as person number and duration in the export_output_data_map table (based on the Output Data Map configuration of these Export Fields). When an Ad Hoc Report with the Export Audit context is run, it can select these person numbers and durations from the export_output_data_map table. If Enable Audit is not checked, then no records will be created in either the export_output_data or export_output_data_map table when the Labor Export is run by the EXPORT service.
Example 2: A Payroll Export runs from the Exports form. The entire export file is placed in the output_data column of the export_output_data table. The export file includes person numbers and durations. If Enable Audit is checked, these values are mapped to the person_num and duration columns in the export_output_data_map table (based on the Output Data Map configuration of these Export Fields). When an Ad Hoc Report with the Export Audit context is run, it can select these person numbers and durations from the export_output_data_map table.
System Required
If this box is checked, the export record cannot be deleted or modified. However, you can copy a system-defined record and then modify it as necessary.
Click Main Menu > Configuration > Interfaces > Export Definition.
Click the
button next to the Export Name
field and select Lookup from
the pop-up menu.
Select a record from the Export pop-up form and click OK.
Click Main Menu > Configuration > Interfaces > Export Definition.
Click the
button next to the Export Name
field and select Add from
the pop-up menu.
On the Export form, enter/select the values. See Field Descriptions for details.
If you want to add more than one Export Name, click Save and Add to save your settings and keep the Export window open. Or click Save to save your Export Name and return to the Export Definition form.
You are now ready to configure the output data. See Export Definition to do so.
Click Main Menu > Configuration > Interfaces > Export Definition.
Click the
button next to the Export Name
field and select Maintain
from the pop-up menu.
On the Export form, select the Export Name you want to copy and click Copy.
On the Copy Export form, change the settings as necessary and click Save.
Click Main Menu > Configuration > Interfaces > Export Definition.
Click the
button next to the Export Name
field and select Maintain
from the pop-up menu.
On the Export form, select the Export Name you want to change and click Modify.
Change the settings as necessary and click Save.
Click Main Menu > Configuration > Interfaces > Export Definition.
Click the
button next to the Export Name
field and select Maintain
from the pop-up menu.
On the Export form, select the Export Name you want to remove and click Delete.
Click OK to confirm the action.