Versions Compared

Old Version 2

changes.mady.by.user Jay-Ar Brouillard

Saved on

compared with

New Version 3

changes.mady.by.user Jay-Ar Brouillard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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*

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

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.

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

  1. Extract JSON File from SCM

  2. Use absolute path to location on server. (Not recommended as it requires manual setup on server)

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

Artifacts

This operation does not produce any artifacts.

...

The JSON objects within the "tasks" array can 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 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 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-Setup Task object type (I.E. Value Set, Lookups, or Flexfields), only Attribute Value and TaskCode are required. 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:

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

Info

Notes

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