Versions Compared

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

...

Property NameProperty CodeRequiredDescription
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.

The account will be likely be different for each FSM environmentOracle SaaS FSM Account will be required on either the input or environment instance. If a value is set on both then, the input will take precedence.

Project Properties

Property NameProperty CodeRequiredDescription




...

Input NameInput CodeRequiredDescription
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 input or environment instance. If a value is set on both then, the input will take precedence.

API Timeout
FDFSM_INP_TIMEOUT
NoMaximum 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
NoAbsolute or relative target folder path. Relative path will be assumed in FD_TEMP_DIR.
Stop on Error
FDFSM_INP_STOP_ON_ERROR
NoStop 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.

...

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.

Image Added

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

...

KeyRequiredDescription
TaskCodeYesCode of the Setup Task.
BusinessObjectCodeNo*

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.

AttributeNameNo*

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.

AttributeValueNo**

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.

*Required to apply scope to non-Value Set Setup Tasks. **In  In the case of Value Set Setup Tasks only Attribute Value and TaskCode are required. BusinessObjectCode and AttributeName can be left empty. See JSON object 5 example in FSMSetupTasks-Development.json

...