The Export Parameters tab on the Export Definition form is used to define the criteria for the data that will be included in an export. The options that are available in this tab form will depend on the type of export you are defining. When you select an Export Name at the top of the Export Definition form, the export’s Context (Action, Charge_Element, Labor, Payroll, etc.) determines the parameters you can set.
This form only sets the default values displayed on the Exports form. For a Payroll Export, you can modify which Pay Groups are included and their start and end dates when you run the export on the Exports form.
See Also:
Export Parameters Field Descriptions
List of Parameters and Descriptions
Configure the Export Parameters
The Export Name and Context Name fields display for all exports. The remaining fields that appear in this form depend on the Context Name of your export.
Export Name
Name of the export you selected from the Export Name field at the top of the Export Definition form.
Context Name
Name of the Export Context defined for the Export Name selected at the top of the Export Definition form. The Context Name identifies the function the export performs.
Parameters
Refer to the List of Parameters and Descriptions for descriptions of the Export Parameters. An export’s Context (Action, Charge_Element, Labor, Payroll, etc.) determines the parameters you can set.
This parameter is only available when the Context Name is Person_Balance. Use this parameter to select the Leave Type Codes you want to export. Available options are defined on the Leave Type Code form. Move the Leave Type Code from Available to Selected if you want it to be exported.
This parameter is only available when the Context Name is Labor. Use this parameter to select which charge types you want to export. Available options are defined in the Charge Type form.
This parameter is only available when the Context Name is Charge_Element. Use this parameter to select which charge types and elements you want to export. Available options are defined in the Charge Type form and Charge Type Element tab form.
This parameter is only available when the Context Name is Person Pin. If you set this parameter to Today, only the PINs that were changed on the current day will be exported. If you leave this parameter blank, then all person numbers and PINs will be exported.
This parameter is available when the Context Name is Payroll.
If you selected Do Not Export as your EXPORT_ZERO_DURATION setting (see below), you must use the DURATION_FIELD_NAME setting to specify the fields that should be excluded if they have a zero duration amount. If you selected Allow Export as your EXPORT_ZERO_DURATION setting, you do not need to select a DURATION_FIELD_NAME.
Move a field from the Available column to the Selected column to exclude it from the payroll export if it has a net zero duration.
Available when the Context Name is Transaction.
This setting determines whether records will be selected by the transaction’s Posting Date or Pay Date. If you leave this parameter blank, the Posting Date value will be used.
This parameter is particularly useful when you are exporting a 9-80 pay period.
For example: There are two pay periods: one from 6/8/2013 to 6/14/2013 and another from 6/15/2013 to 6/21/2013. Friday 6/14/2013 is a split Friday, with 4 hours posted on the first half for the first pay period and 5 hours posted on the second half for the next pay period. The Export is run from 6/8/2013 to 6/14/2013. If EXPORT_DATE_RANGE_TYPE is set to Pay Date, the export will only include the 4 hours from the first half of the split day, since the 5 second-half hours have a pay date of 6/21/2013. If EXPORT_DATE_RANGE_TYPE is set to Posting Date, the export will have both the 4 hours and the 5 hours, since both were posted on 6/14/2013.
Note: If a Transaction export is run from the Exports form, the EXPORT_DATE_RANGE_TYPE will also determine whether the PAY_DATE parameter or the POST_DATE parameter is used. If EXPORT_DATE_RANGE_TYPE is blank or set to Posting Date, then only the value of the POST_DATE parameter will be considered. Likewise, if the EXPORT_DATE_RANGE_TYPE is set to Pay Date, then only the value of the PAY_DATE parameter will be considered. If the Transaction export is run from a service, then both the PAY_DATE and POST_DATE parameters will be considered.
This parameter is available when the Context Name is Payroll. It indicates whether a transaction with a net zero amount, such as a prior period adjustment, will be included in the payroll export. It also affects any transaction that has a zero duration and an hours classification.
For example, after a timecard is processed for payroll, one of the days in the period is adjusted. A day with 13 hours (classified as 8 R and 5 O) is modified to 12.43 hours (classified as 8 R and 4.43 O). Although the overtime hours have changed, the regular hours have not changed. When the adjusted timecard is exported, the EXPORT_ZERO_DURATION setting indicates whether the regular hours – which will show a zero duration because there was no change from the previous export – should be included in the payroll export.
Select Allow Export to export net zero duration amounts.
Select Do Not Export to exclude net zero duration amounts from the payroll export. You must also use the DURATION_FIELD_NAME setting (see above) to specify the fields to exclude.
This parameter is available when the Context Name is Payroll.
The available options are Charge Elements of type EXTERNAL_PAY_GROUP.
Use this parameter if you want your Payroll Export to include employees that are assigned to a specific External Pay Group. Employees are assigned to an External Pay Group in the Assignment tab of the Employee form. See External File Number and External Pay Group in Payroll Export.
To export records for employees in an External Pay Group, move the External Pay Group from the Available column to the Selected column. Only the External Pay Groups in the Selected Column will be exported. If you do not select any External Pay Groups, then none will be exported.
Note that the Payroll Export first selects employees based on the PAY_GROUP_NAME parameter. It then selects employees belonging to these Pay Policies that have been assigned to the selected External Pay Group.
This parameter is only available when the Context Name is Labor. Use this parameter to select which facility’s records you want to export. Available options are defined in the Person Group form with Person Group Type FACILITY.
This parameter is only available when the Context Name is Labor.
This parameter is used when the START_DATE and END_DATE parameters are set to Fiscal Week Start and Fiscal Week End. These parameters specify the date range for the records you are exporting based on a Fiscal Calendar.
This parameter is available when the Context Name is Payroll.
Indicates whether all the available Pay Policies will be included in the Payroll Export.
Select True if you want to include all available Pay Policies in the Payroll Export, regardless of which policies are in the Selected column of the PAY_GROUP_NAME parameter. If you create a new Pay Policy, it will automatically be included in the Payroll Export.
Select False if you only want the Payroll Export to include Pay Policies in the Selected column of the PAY_GROUP_NAME parameter.
This parameter is only available when the Context Name is Transaction.
Set this parameter to Yes to export transactions with a duration greater than zero (0) and a classification that is not null.
This parameter is only available when the Context Name is Labor.
Use this parameter to indicate whether Transaction Duration Detail (trans_action_duration_detail) records should be included in the Labor Export. Transaction Duration Detail records have information about payroll and labor rates, amounts, and locations for the transaction. If the transaction is a premium transaction, the Transaction Duration Detail records will show the Base (regular), Hours premium, and Shift premium portions of the transaction.
If your Labor Export needs to include the base, shift premium, and hours premium portions of a transaction, set this parameter to True to include Transaction Duration Detail records in the export.
If you set this parameter to False, Transaction Duration Detail records will not be included in your Labor Export.
Available when the Context Name is Message.
Use this parameter to export messages that have a particular Message Definition.
Available options are defined in the Message Definition form. Move the Message Definition from Available to Selected if you want messages that use this Message Definition to be exported.
Available when the Context Name is Message.
Use this parameter to export messages that resulted from a particular Message Trigger.
Available options are defined in the Trigger tab of the Message Policy form. Move the Message Trigger from Available to Selected if you want messages that resulted from this Message Trigger to be exported.
Available when the Context Name is Message.
Use this parameter to export a specific type of message. Available options are:
SYSTEM_ALERT_MESSAGE: Message was generated by the MESSAGE_CREATION service based on a Message Definition of type SYSTEM or EXCEPTION.
BUSINESS_EVENT_MESSAGE: Message was created by a message trigger
BROADCAST_MESSAGE: Message was created and sent from the Broadcast Message form.
DIALOG_MESSAGE: Message was generated by the MESSAGE_CREATION service based on a Message Definition of type DIALOG.
Move the Message Type from Available to Selected if you want messages with this type to be exported.
Available when the Context Name is Message. Use this parameter to export messages with a particular status. Move the Message Status from Available to Selected if you want messages with this status to be exported.
Available options are:
UNREAD: The message has not yet been read by the recipient.
READY_FOR_DELIVERY_VIA_EMAIL: The message is ready to be delivered by the MESSAGE_DELIVERY service.
DELIVERED_VIA_EMAIL: The MESSAGE_DELIVERY service delivered the message to the person’s email address.
READ_ON_WEB: The message was read by the recipient in the web application.
READ_ON_TERMINAL: The message was read by the recipient on the terminal.
NOT_DISPLAYED: The message has not been displayed to the recipient. For example, a dialog message may include multiple messages that display based on the user’s response to the previous message in the dialog. If the user’s response prevents the additional messages from displaying, the status of these additional messages will be Not Displayed.
CANCELLED: The message was cancelled in the Message Log form. The message will not be displayed to the recipient on the terminal/web and the MESSAGE_DELIVERY service will not send the message.
Available when the Context Name is Transaction. Use this parameter to export only records with a Quantity Complete that is greater than or equal to this minimum amount. If a transaction does not have a Quantity Complete that is greater than or equal to the MINIMUM_COMPLETION_QUANTITY, the transaction will not be exported.
Available when the Context Name is Transaction. Use this parameter to export only records with a Quantity Accepted, Quantity Rejected, or Quantity Scrapped that is greater than or equal to this minimum amount. If none of these fields have an amount greater than or equal to the MINIMUM_INSPECTION_QUANTITY, the transaction will not be exported.
This parameter is available when the Context Name is Labor or Transaction.
Use this parameter to restrict the transactions that will be exported based on their Pay Date. For example, you may want to prevent transactions with a Pay Date in the future from being exported.
All: The default value for this parameter is All. With this option, transactions will be exported regardless of whether the Pay Date is current, in the past, or in the future.
Current: With this setting, only transactions with a Pay Date that is earlier than or equal to the current date will be exported. Select this option if you want to prevent transactions with a Pay Date in the future from being exported.
The POST_DATE parameter (see below) is used to restrict the transactions that will be exported based on their Post Date. Normally, a transaction’s Pay Date and Post Date are the same. In these cases, if the PAY_DATE and POST_DATE parameters have different settings, then the more restrictive setting (Current) will be used.
In some cases, such as 9-80 schedules, the Pay Date and Post Date will be different and the PAY_DATE and POST_DATE parameters will be considered separately.
For example: There are two pay periods: one from 6/6/2015 to 6/12/2015 and another from 6/13/2015 to 6/19/2015. Friday 6/12/2015 is a split Friday, with 4 hours posted on the first half for the first pay period and 5 hours posted on the second half for the next pay period. Both the first- and second-half hours have the same Post Date (6/12/2015). However, the Pay Date for the 4 hours on the first half is 6/12/2015 and the Pay Date for the 5 hours on the second half is 6/19/2015.
The export is run on Saturday 6/13. When Friday 6/12 is exported, and PAY_DATE is set to All, then both the 4 hours from the first half of the split day and the 5 second-half hours will be exported. However, if PAY_DATE is set to Current, then only the 4 hours from the first half of the split day will be exported.
Note: If a Transaction export is run from the Exports form, the EXPORT_DATE_RANGE_TYPE will determine whether the PAY_DATE parameter or the POST_DATE parameter is used. If EXPORT_DATE_RANGE_TYPE is blank or set to Posting Date, then only the value of the POST_DATE parameter will be considered. Likewise, if the EXPORT_DATE_RANGE_TYPE is set to Pay Date, then only the value of the PAY_DATE parameter will be considered. If the Transaction export is run from a service, then both the PAY_DATE and POST_DATE parameters will be considered.
This parameter is available when the Context Name is Payroll.
The available options are defined in the Pay Policy form.
When you select a Pay Policy, employees who are assigned to that Pay Policy will have their records exported with the Payroll Export.
To include a Pay Policy, move it from the Available column to the Selected column. The Pay Policies in the Selected column will be exported.
You can also set the INCLUDE_ALL_PAY_GROUPS parameter to True to include all available Pay Policies in the Payroll Export, regardless of which policies are in the Selected column of the PAY_GROUP_NAME parameter. If you create a new Pay Policy, it will automatically be included in the Payroll Export.
You must select at least one Pay Policy in the PAY_GROUP_NAME parameter or set INCLUDE_ALL_PAY_GROUPS to True.
Available when the Context Name is Payroll.
This field sets the default start date for the parameters in your export.
You can set the PAY_GROUP_START_DATE to be the PAY_PERIOD_START_DATE or a ZERO_DATE.
PAY_PERIOD_START_DATE: The parameter start dates will default to the start of the pay period.
ZERO_DATE: The parameter start dates will default to 1/1/1970.
This parameter is available when the Context Name is Person.
Use this parameter to select the Person Groups to include in the export. Available options are Person Groups of type DIRECT or SUPERVISOR_MANAGER, and Hierarchy Groups defined in the Hierarchy Elements form. Move the Person Group from Available to Selected if you want it to be exported.
This parameter is only available when the Context Name is Transaction. Use this parameter to select which Person Types should have their transactions exported. Available options are Person Types defined in the Person and Employment Profile forms. Move the Person Type from Available to Selected if you want it to be exported.
This parameter is available when the Context Name is Person Balance.
Use this parameter to export person balance records for a specific Policy Group. Available options are Person Groups of type POLICY_GROUP defined in the Person Group form.
This parameter is available when the Context Name is Labor or Transaction.
Use this parameter to restrict the transactions that will be exported based on their Post Date. For example, you may want to prevent transactions with a Post Date in the future from being exported.
All: The default value for this parameter is All. With this option, transactions will be exported regardless of whether the Post Date is current, in the past, or in the future.
Current: With this setting, only transactions with a Post Date that is earlier than or equal to the current date will be exported. Select this option if you want to prevent transactions with a Post Date in the future from being exported.
If you are using an export service with the MODE parameter, make sure the service’s MODE parameter coincides with this POST_DATE parameter. See POST_DATE Parameter and MODE Service Parameter.
The PAY_DATE parameter (see above) is used to restrict the transactions that will be exported based on their Pay Date. Normally, a transaction’s Pay Date and Post Date are the same. In these cases, if the PAY_DATE and POST_DATE parameters have different settings, then the more restrictive setting (Current) will be used.
In some cases, such as 9-80 schedules, the Pay Date and Post Date will be different and the PAY_DATE and POST_DATE parameters will be considered separately. Refer to the PAY_DATE parameter description (above) for an example.
Note: If a Transaction export is run from the Exports form, the EXPORT_DATE_RANGE_TYPE will determine whether the PAY_DATE parameter or the POST_DATE parameter is used. If EXPORT_DATE_RANGE_TYPE is blank or set to Posting Date, then only the value of the POST_DATE parameter will be considered. Likewise, if the EXPORT_DATE_RANGE_TYPE is set to Pay Date, then only the value of the PAY_DATE parameter will be considered. If the Transaction export is run from a service, then both the PAY_DATE and POST_DATE parameters will be considered.
POST_DATE Parameter and MODE Service Parameter
If you are using an export service with the MODE parameter, make sure the service’s MODE parameter coincides with this POST_DATE parameter. For example, if you are using the OUT_EBS_PROJECT service to send project data to Oracle EBS, make sure the service’s MODE parameter is the same as the Export Definition’s POST_DATE parameter. If the service’s MODE is TODAY, the Export Definition’s POST_DATE parameter should be set to Current. If the service’s MODE is ALL, then the Export Definition’s POST_DATE parameter should also be set to All. If these settings are different, then the more restrictive setting will be used (Current/TODAY).
The following service instances use the MODE parameter:
EXPORT
OUT_EBS_AP_EXPORT
OUT_EBS_GL_EXPORT
OUT_EBS_PROJECT
OUT_EBS_WIP_COST
OUT_SAP
This parameter is only available when the Context Name is Labor or Action.
For Action Exports:
Set the PROCESS_NAME to ACTION_EXPORT unless you are sending a zero order CONF21 IDOC to SAP to indicate when the first labor activity has started on an order or operation. In this case, set the PROCESS_NAME to OUT_SAP_ZERO_CONF21. See Send Zero Order Confirmation to SAP..
For Labor Exports:
Set the PROCESS_NAME to Labor if you are defining a Labor Export. A Labor export is used to export employee labor data to external systems. You can specify which charge types and which facilities you want to export. You can also define which events you want to export.
Set the PROCESS_NAME to Labor Distribution if you are defining a Labor Distribution Export. A Labor Distribution export shows all the transactions (paid and unpaid) for the pay period for each employee. A Labor Distribution export is designed to follow a Payroll Export.
Set the PROCESS_NAME to Out AP Export if you are defining an AP Export to Oracle EBS.
Set the PROCESS_NAME to Out EBS Project if you are defining a Project Export to Oracle EBS.
Set the PROCESS_NAME to OUT SAP CONF21 if you are defining a Production Planning Order/Operation export to SAP for the CONF21 IDOC.
Set the PROCESS_NAME to OUT SAP CONF32 if you are defining a Plant Maintenance Order/Operation export to SAP for the CONF32 IDOC.
Set the PROCESS_NAME to OUT SAP CONF42 if you are defining a Project Systems Order/Operation export to SAP for the CONF42 IDOC.
Set the PROCESS_NAME to Out EBS WIP Cost if you are defining a WIP Cost export to Oracle EBS. This type of export sends work order data to Oracle EBS to track production costs (work in process costs).
Set the PROCESS_NAME to OUT EBS GL Export if you are defining a GL Export to Oracle EBS.
This parameter is only available when the Context Name is Labor or Transaction.
Use this parameter to specify whether you want to export positive hours, negative hours, or both. This parameter works by exporting only those records with a particular processing status.
Positive: Select Positive to export to export records with positive hours (status of R - Ready).
Negative: Select Negative to export to export records with negative hours (status of Z - Cancelled After Processing).
All: Select All to export to export records with positive and negative hours (both R and Z status). All is the default value.
This parameter is only available when the Context Name is Charge_Element, Message, Person, Person_Balance, or Person_Info.
Identifies the system from which this data originated. This field is optional.
Select AUTOTIME, AUTOTIME6, IMPORT, SOLUMINA_MFI, ORACLE_EBS, ORACLE_WIP, or WS_CLIENT.
These parameters are only available when the Context Name is Person_Balance or Labor. The available options for these parameters are different for each context.
For a Person_Balance export:
Use these parameters if you only want to export balance information from a specific date range.
For a Labor export:
Use these parameters to specify the date range for the records you are exporting.
The START_DATE can be Zero Date or Fiscal Week Start. Select Zero Date if you want the start date to be 01/01/1970. Select Fiscal Week Start if you want the start date to be the start of the previous fiscal week. You will also need to select a FISCAL_CALENDAR. If you leave the START_DATE blank, the start date for the exported records will be the current date.
The END_DATE can be left blank or set to Fiscal Week End. If you select Fiscal Week End, the end date for the exported records will be the end of the previous fiscal week. You will also need to select a FISCAL_CALENDAR. If you leave the END_DATE blank, the end date for the exported records will be the current date.
This parameter is only available when the Context Name is Labor.
Use this parameter to select the Vendors that should be included in the labor export. See Subcontractors for more information.
To include a Vendor, move it from the Available column to the Selected column. The Vendors in the Selected Column will be exported.
Click Main Menu > Configuration > Interfaces > Export Definition.
Select the Export Name for which you want to configure your parameters.
Click the Export Parameters tab.
Change the settings as necessary and click Save. Refer to the field descriptions above for more information on these settings.
To revert to the settings that appeared when you first opened the form, click Reset.