Exports CSV File Package(s) from an Oracle SaaS FSM server to the file system. This operation can be used from an a 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.

Tip

title

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
Oracle SaaS FSM Account	`FDFSM_CLOUD_ACCOUNT_CODE`	No*

The

Oracle SaaS FSM

account with all the required properties like instance URL, Username, and Password.Oracle SaaS FSM

Account will be required on either the plugin input or

environment instanceProperty NameProperty CodeRequiredDescription

Target. If a value is set on both then, the plugin input will take precedence.

Project Properties

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

Inputs

Input Name	Input Code	Required	Description
Oracle SaaS FSM Account	`FDFSM_INP_CLOUD_ACCOUNT_CODE`	No

The Oracle CPQ account with all the required properties like instance URL, Username, and Password.

*	Oracle SaaS FSM Account will be required on either the plugin input or

environment instance

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.
Stop on Error	`FDFSM_INP_STOP_ON_ERROR`	No	Stop exporting CSV File Package, if any error occurs. If false or not specified, exporting of other CSV File Packages will continue.
JSON File Path	`FDFSM_INP_JSON_FILE_PATH`	Yes	Absolute or relative path to a file containing a json array of tasks. Relative path will be assumed in FD_TEMP_DIR. You can either Extract JSON File from SCM Use absolute path to location on server. (

not

Not recommended as it requires manual setup on server)

See special considerations for more information about format and contents of JSON File Path.

Outputs

Output NameDescription

Artifacts

This operation does not produce any artifacts.

...

This operation will select all available endpoints associated to the environment/instanceTarget.

Endpoint Execution

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

...

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.

...

JSON File Path

csvDownloadAdvanced is expecting a file containing a json object with an array of data, which we call tasks. Recommendation is to name this file something along the lines of "FSMSetupTasks-Development" and give it an extension of .json. The "Development" postfix on the file name is to denote that these tasks will get exported from your Development Oracle SaaS FSM environment. Typically user will maintain one json file containing the below content because syncing to SCM process happens against one SaaS environment (Development in this case).

...

FSMSetupTasks-Development.json

Code Block

linenumberslanguage	truejava

{
  "tasks" :
  [
    { 
      "TaskCode" : "PAY_MANAGE_FAST_FORMULA",
      "BusinessObjectCode" : "",
      "AttributeName" : "",
      "AttributeValue" : ""
    },
    {
      "TaskCode" : "PAY_MANAGE_FAST_FORMULA",
      "BusinessObjectCode" : "FF_FORMULA",
      "AttributeName" : "FormulaName1",
      "AttributeValue" : "EXT_ASSIGNMENTS_RECORD300000189455050_300000189455050"
    },
    {
      "TaskCode" : "PAY_MANAGE_FAST_FORMULA",
      "BusinessObjectCode" : "FF_FORMULA",
      "AttributeName" : "BaseFormulaName",
      "AttributeValue" : "EXT_BENEFITS_RECORD300000189455103_300000189455103##EXT_PERFORMANCES_RECORD300000189455100_300000189455100"
    },
    {
      "TaskCode" : "FUN_MANAGE_BUSINESS_UNIT",
      "BusinessObjectCode" : "FUN_BUSINESS_UNIT",
      "AttributeName" : "Name",
      "AttributeValue" : "AU Council Business Unit"
    },
    {
      "TaskCode" : "GL_MANAGE_CHART_OF_ACCOUNTS_VALUE_SETS",
      "BusinessObjectCode" : "",
      "AttributeName" : "",
      "AttributeValue" : "FlexDeploy Value Set Accounts##FlexDeploy Value Set Currencies"
    }
  ]
}

Referencing the above list of "tasks" one by one:

Downloads the entire Fast Formula task
- Notice only TaskCode is set
Downloads the Fast Formula task scoped by Formula Name of EXT_ASSIGNMENTS_RECORD300000189455050_300000189455050
- Notice all values are set and AttributeValue has only single value
Downloads the Fast Formula task scoped twice. Once scoped by base formula name of EXT_BENEFITS_RECORD300000189455103_300000189455103 and a second time scoped by base formula name of EXT_PERFORMANCES_RECORD300000189455100_300000189455100
- When 2 more values are set (delimited by ##), then an individual CSV File package is downloaded for each value with respective scope applied.
Downloads the Manage Business Unit task scoped by Name of AU Council Business Unit
Downloads the Manage Chart of Accounts Value Set task twice. Once filtered by value set code of FlexDeploy Value Set Accounts and a second time filtered by value set code of FlexDeploy Value Set Currencies.

Format of the The JSON objects within the "tasks" array require 4 key-value pairscan contain these 5 keys.

Key

Required

Description

TaskCode

Yes

Code of the Setup Task.

BusinessObjectCode

No*

Code of the business object whose attribute is used as the scope. Leave value empty to export entire Setup Task.

*Required to apply scope to

non-Value Set Setup Tasks

Setup Task object type.

AttributeName

No*

Name of the attribute of the business object used as the scope. Leave value empty to export entire Setup Task.

*Required to apply scope to

non-Value Set Setup Tasks

Setup Task object type.

AttributeValue

No*

Value of the named attribute that defines the filter criteria. Provide multiple values using ## I.E. VALUE1##VALUE2. Leave value empty to export entire Setup Task.

If you provide more than one value using ## separator, individual file for each value is downloaded.

*Required to apply scope to Setup Task object type. Otherwise, all supported non-

Value Set Setup Tasks. In the case of Value Set Setup Tasks

Setup Task object type (I.E. Value Set, Lookups, or Flexfields), only Attribute Value and TaskCode are required.

BusinessObjectCode

BusinessObjectCode and AttributeName can be left empty. See JSON object 5 example in FSMSetupTasks-Development.json

FileName

No*

Name of zip file. If no provided attribute value is used as zip file name. Spaces in name are replaced with _.

If multiple values are provided for AttributeValue using ## separator, you can provide same number of elements for FileName as well for individual file.

Download Folder Structure

csvDownloadAdvanced maintains the following folder structure convention when saving the CSV File packages to the file system:If only

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

...

title	Notes

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

Info

Notes

All spaces in file path / name will be replaced with double underscore .

Image Removed

...

and : will be replaced with %3a.

Versions Compared

Old Version 4

New Version Current

Key

Endpoint Tip

Target Properties

Project Properties

Inputs

Outputs

Artifacts

Endpoint Execution

JSON File Path

FSMSetupTasks-Development.json

Download Folder Structure

Notes

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Endpoint Tip

Target Properties

Project Properties

Inputs

Outputs

Artifacts

Endpoint Execution

JSON File Path

FSMSetupTasks-Development.json

Download Folder Structure

Notes