csvExport

This operation exports file(s) from the build Oracle SaaS environment or your SCM repository, waits for all exports processes to complete, and then downloads results as a single zip file artifact. The csvExport operation can only be used with a FlexDeploy package-based deployment project of type Oracle SaaS FSM.

Artifact is a single zip file containing zipped CSV or json File Packages.

As of 6.5.0.20, 7.0.0.11, 8.0.0.6, and 9.0.0.0, this operation will export some files as json files, and others as CSV files. Both can be uploaded successfully by the import operation. The types of files that are now downloaded as JSON instead of CSV are a subset of Value Sets and Lookups. The JSON download is much faster and smaller than the CSV one is. The resolves several issues that customers brought up where value sets and look ups were not exported properly due to file size restrictions in the export process.

Value Sets are downloaded as JSON now instead of CSV if the following criteria are met:

image-20240916-171053.png
  • The Type is set to Value Set

  • The TaskCode is set to FND_MANAGE_VALUE_SETS

  • The ValueSetCode AttributeValue is set to the ValueSetCode of the ValueSet that you wish to download.

These criteria are met for the auto-discovered Value Sets.

Lookups are downloaded as JSON now instead of CSV if the following criteria are met:

image-20240916-171409.png
  • The Type is set to Lookups

  • The TaskCode can be set to any of the following: FND_MANAGE_SET_ENABLED_LOOKUPS, FND_MANAGE_COMMON_LOOKUPS, or FND_MANAGE_STANDARD_LOOKUPS.

  • The Lookup Type is set to the LookupType of the Lookup that you wish to download.

These criteria are met for the auto-discovered Lookups.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Oracle SaaS FSM Account

FDFSM_CLOUD_ACCOUNT_CODE

No*

Oracle SaaS FSM Account will be required on either the plugin input or Target. If a value is set on both then, the plugin input will take precedence.

See Special Considerations below for instructions on how to create Oracle SaaS FSM account.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Oracle SaaS FSM Account

FDFSM_INP_CLOUD_ACCOUNT_CODE

No*

Oracle SaaS FSM Account will be required on either the plugin input or Target. If a value is set on both then, the plugin input will take precedence.

See Special Considerations below for instructions on how to create Oracle SaaS FSM account.

API Timeout

FDFSM_INP_TIMEOUT

No

Maximum amount of time (seconds) to wait for export process to complete after it is started. Defaults to 900 seconds (15 minutes).

Save Export Result File

FDFSM_INP_SAVE_EXPORT_RESULT_FILE

No

Saves a comparison result file to the reports directory as a JSON file. The JSON file provides a summary of the comparison process and represents the table shown in the Comparison Details section of the user interface.

Save Export Report File

FDFSM_INP_SAVE_EXPORT_REPORT_FILE

No

Saves a comparison report file to the reports directory as a HTML file. The HTML file provides comparison reports for each of the business objects that were processed. For each business object, a report each for Only in Configuration 1, In Both With Mismatch, and Only In Configuration 2, as applicable is provided.

Save Export Summary Report File

FDFSM_INP_SAVE_EXPORT_SUMMARY_REPORT_FILE

No

Saves a comparison report file to the reports directory as a HTML file. The HTML file provides a summary of the process results, which displays a list of all the processed business objects, and whether their processing completed successfully, or with errors.

Filter Criteria Preview Mode

FDFSM_INP_FILTER_CRITERIA_PREVIEW_MODE

No

When enabled no artifacts, CSV file package(s), will be generated. Instead before and after zip files will be provided in FD_REPORTS_DIR along with diff and unified diff files to validate filter criteria behavior. Make sure this is disabled at build time if you wish to deploy setup changes. Defaults to false.

Artifacts

This operation produces artifacts that will be stored in the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the Target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

Oracle SaaS FSM Account*

Before using this plugin operation, navigate to Topology → Integrations → Cloud, then create an account with provider OracleFSM for each one of your SaaS environments. This account will store the URL and credentials to make HTTPS requests to your SaaS environment. The account will be reusable by all Oracle SaaS FSM Plugin operations. All fields shown are required.

See Object Type - Setup Task, Oracle SaaS FSM Object Type - Fast Formula, Oracle SaaS FSM Object Type - Value Set, etc.. for details on how to configure Files for export.

FSM Setup Task Export Reports

CSVExport can generate additional reports and log files which are viewable and downloadable from workflow execution → reports tab. The .log file will always be a generated report. Keep in mind, the contents of the .log file will also be outputted to the plugin log file. Additional reports that can be generated include:

  • <TASK_CODE>_ProcessResultsSummaryReport_<EXPORT_DATE_TIME>.html - A high level overview of the number of objects exported and the execution time

  • <TASK_CODE>_ProcessResultsReport_<EXPORT_DATE_TIME>.html - A high level overview of the objects exported by business object and the execution time for each

  • <TASK_CODE>_ProcessResult _<EXPORT_DATE_TIME>.json - The response body from the Export API after export has completed. This is generally not used but provided regardless.

To include any of the additional reports, you must enable those in the csvExport workflow operation.

Example reports:

XLE_MANAGE_LEGAL_REPORTING_UNIT_ProcessLog_20231208_123744_0831.log

The export operation was initiated calling the export API as indicated below. Export operation: submitTaskCSVExport.Request ID: 7,176,630. Status: In progress. Submitted By: CURTIS.FEITTY. Process Date: 12/8/23 6:36 PM. The implementation project Manage Legal Reporting Unit_20231208_063617_114 was exported successfully. Business object: Legal Reporting Unit. Status: In progress. Status details: Detail Object: LegalLocation. Status: Completed successfully. Status Details: A total of 98 rows were processed. 0 rows of them failed and 0 rows completed with warnings.. Started: 12/8/23 6:36 PM. Ended: 12/8/23 6:36 PM. Business object: Legal Reporting Unit. Status: Completed successfully. Status details: Detail Object: LegalEntityData. Status: Completed successfully. Status Details: A total of 2 rows were processed. 0 rows of them failed and 0 rows completed with warnings.. Started: 12/8/23 6:37 PM. Ended: 12/8/23 6:37 PM. Detail Object: LegalLocation. Status: Completed successfully. Status Details: A total of 98 rows were processed. 0 rows of them failed and 0 rows completed with warnings.. Started: 12/8/23 6:36 PM. Ended: 12/8/23 6:36 PM. Total Objects Processed: 1 Total Objects Succeeded: 1 Total Objects Failed: 0 Total Objects with Warnings: 0 Total Objects for External Loading: 0 Request ID: 7,176,630. Status: Completed successfully. Submitted By: CURTIS.FEITTY. Process Date: 12/8/23 6:37 PM.

XLE_MANAGE_LEGAL_REPORTING_UNIT_ProcessResultsSummaryReport_20231208_123744_0831.html

XLE_MANAGE_LEGAL_REPORTING_UNIT_ProcessResultsReport_20231208_123744_0831.html

How to find Task Code for a Setup Task?

To initiate the export or import process, Oracle endpoints requires providing a code for the task. Following these instructions to find the Task Code. We are assuming you have access to FSM resource.

  1. Click Navigator > My Enterprise > Setup and Maintenance.

  2. In the Setup and Maintenance work area, click Manage Setup Content from the Tasks panel tab.

  3. To search for the code of a task

    1. On the Manage Setup Content page, click Manage Task Lists and Tasks.

    2. In the Search field, select Tasks and click Search.

    3. In the search results, click the name of the task.

    4. On the Task page, look for value that appears against Code.

    5. Copy the code and use it where necessary

The following macros are not currently supported in the footer:
  • style