Setup Tasks allow for export and import of setup task as a CSV File package (zip file). If supported, scope can be applied to export a subset of the CSV File package data via Export Criteria. Export Criteria can be easily configured via the FlexDeploy during manual file creation. In the case, scope cannot be applied, please see other supported Oracle Saas FSM object types as an alternative solution.
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object Type Identification
...
Name | Code | Description | Default Value | Supported Values |
|---|---|---|---|---|
Source |
| Object Source Location Type |
|
|
Task Code |
| Unique id for Setup Task |
| |
Export Criteria |
| Export Criteria used to apply scope to a setup task. | ||
Filter Criteria |
| After export, filter criteria is used to apply additional filtering to the setup task. |
Offering code and Functional Area attributes were available prior to 5.6.0.5, They are not needed and hence removed.
Special Considerations
Export Criteria
...
Please follow help provided in UI to enter attribute values for export criteria. See known issues and special consideration below for specific Setup Task.
Manage HCM Extract Definitions
...
To export an HCM Extract, use the PER_MANAGE_EXTRACT_DEFINITION Task Code.
...
Export by ExtDefinitionId works but that id is not visible
...
in FSM UI, you can upload this BIP Report
| View file | ||
|---|---|---|
|
ASM_SETUP_CSV_METADATA.xml which is part of Export zip file. ...
Payroll Flow Patterns - this requires use of FlowId, which is not visible on FSM UI. Other values do not work with Export CSV API. There are few options to get FlowId:
...
See https://docs.oracle.com/en/cloud/saas/human-resources/21d/oedmh/perextdefinitionsb-13198.html#perextdefinitionsb-13198 to write an adhoc BIP report to query the underlying FSM tables and retrieve name & associated FlowId.
...
Manually export from FSM UI to capture FlowId from ASM_SETUP_CSV_METADATA.xml which is part of exported CSV zip file.
Manually execute the Get all flow patterns REST API https://docs.oracle.com/en/cloud/saas/human-resources/24b/farws/op-flowpatterns-get.html using query parameter by BaseFlowNow or other field. The response body will contain FlowId. Example response below
...
Otherwise, filter on a different Attribute Name.
| Note |
|---|
Note that there is a known issue with HCM Extract Definitions. Oracle does not update them if they exist, and there isn’t an API available to rename or delete them. The import is reported as successful, but the extract is not updated. Please log an Oracle SR if you would like to see this changed. |
Payroll Flow Patterns
Export using BaseFlowName, plugin will automatically convert to use appropriate FlowId when you use BaseFlowName in export criteria.
| Info |
|---|
The Payroll Flow Patterns task will work only for custom tasks, seeded ones will not get exported. The Flow Status should be active as well. |
Filter Criteria
Filter criteria are a list of rules used to filter the setup data after CSV export. This means if export criteria are configured, then filter criteria are applied to the result of that. The filter criteria are useful when the user only wants to deploy, a subset of the setup data to the target Oracle SaaS environment(s) and export criteria alone is not sufficient. It is recommended to start with export criteria first and after use filter criteria to fill any gaps if additional filtering is required by your use case. While export criteria only works for specific tasks and attributes combinations; filter criteria are configurable for any task and attribute. A couple reasons export criteria is preferred:
...