csvDownload

Exports CSV File Package(s) for single Setup Task from an Oracle SaaS FSM server to the file system. This operation can be used from an utility workflow, which can also be augmented to sync the files to a source control management system (such as Git or Subversion). This allows the Oracle SaaS FSM project which is used for build and deployment to source from a source code repository rather than directly from a development SaaS instance.

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, but the JSON packages will show as different files in SCM, so you may need to manually remove the old files if you use the operation both before and after upgrading between those versions. 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:

  • The TaskCode is set to FND_MANAGE_VALUE_SETS

  • The AttributeName is set to ValueSetCode

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

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

  • The TaskCode is set to one of FND_MANAGE_COMMON_LOOKUPS, FND_MANAGE_STANDARD_LOOKUPS, or FND_MANAGE_SET_ENABLED_LOOKUPS

  • The AttributeName is set to LookupType

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

Limitation

This operation is a simple export, meaning you can only export a single task or multiple subsets of a single task. Unlike other download operations, you cannot do export of all Setup Tasks in a single execution. To achieve similar functionality, see csvDownloadAdvanced which takes an input file to download more than a single Setup Task.

Endpoint Tip

This operation uses HTTPS to communicate remotely to the Oracle SaaS FSM server, and therefore, can be executed on any endpoint (including LOCALHOST).

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).

Download Folder

FDFSM_INP_DOWNLOAD_FOLDER

No

Absolute or relative target folder path. Relative path will be assumed in FD_TEMP_DIR.

Task Code

FDFSM_INP_TASK_CODE

Yes

Code of the Setup Task.

Business Object Code

FDFSM_INP_BUSINESS_OBJECT_CODE

No**

Code of the business object whose attribute is used as the scope.

Attribute Name

FDFSM_INP_ATTRIBUTE_NAME

No**

Name of the attribute of the business object used as the scope.

Attribute Value

FDFSM_INP_ATTRIBUTE_VALUE

No**

Value of the named attribute that defines the filter criteria. Provide multiple values using ## I.E. VALUE1##VALUE2

Artifacts

This operation does not produce any artifacts.

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.

Optional Inputs**

Business Object Code, Attribute Name, and Attribute Value are usually all required when exporting any Setup Tasks with a scopeable business object.

In the special case of JSON exports of Value Sets or Lookups, specify the Attribute Name as ValeSetCode or LookupType respectively, and use Attribute Value to pass in the LookupType or ValueSetCode.

In the special case of Value Set tasks (I.E. Manage Chart of Accounts Value Sets, Manage Applications Core Value Sets, Manage Purchasing Value Sets, etc..). only FDFSM_INP_ATTRIBUTE_VALUE input is required. You must provide the Value Set Code for the Value Set in order to download a subset of the Value Set. See below image as an example.

image-20240305-185456.png

Download Folder Structure

csvDownload maintains the following folder structure convention when saving the CSV File packages to the file system:

Inputs Provided

Output File

Inputs Provided

Output File

Only FDFSM_INP_TASK_CODE is provided

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/<FDFSM_INP_TASK_CODE>.zip

If FDFSM_INP_TASK_CODE and FDFSM_INP_ATTRIBUTE_VALUE is provided

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/<FDFSM_INP_TASK_CODE>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

If FDFSM_INP_TASK_CODE and FDFSM_INP_ATTRIBUTE_VALUE is provided,

and task is ValueSet related

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/ValueSets/<FDFSM_INP_TASK_CODE>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

If FDFSM_INP_TASK_CODE and FDFSM_INP_ATTRIBUTE_VALUE is provided,

and task is Lookup related

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/Lookups/<FDFSM_INP_TASK_CODE>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

If FDFSM_INP_TASK_CODE and FDFSM_INP_ATTRIBUTE_VALUE is provided,

and task is FlexField related

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/FlexFields/<FDFSM_INP_TASK_CODE>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

If FDFSM_INP_TASK_CODE and FDFSM_INP_ATTRIBUTE_VALUE is provided,

and task is Fast Formula related

<FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/FastFormulas/<FDFSM_INP_TASK_CODE>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

Notes

All spaces in file path / name will be replaced with underscore and : will be replaced with %3a.

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