Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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.

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

Environment/Instance Properties

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

Project Properties

Property NameProperty CodeRequiredDescription




Inputs

Input NameInput CodeRequiredDescription
Oracle SaaS FSM Account
FDFSM_INP_CLOUD_ACCOUNT_CODE
NoThe Oracle CPQ account with all the required properties like instance URL, Username, and Password.
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.

Outputs

Output NameDescription


Artifacts

This operation does not produce any artifacts.

Endpoint Selection

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

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

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
{
  "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:

  1. Downloads the entire Fast Formula task
    • Notice only TaskCode is set
  2. 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
  3. 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.
  4. Downloads the Manage Business Unit task scoped by Name of AU Council Business Unit
  5. 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 JSON objects within the "tasks" array require 4 key-value pairs. 

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

Download Folder Structure

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

If only FDFSM_INP_TASK_CODE input is provided: <FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/<Name of the Setup Task>.zip

Otherwise: <FDFSM_INP_DOWNLOAD_FOLDER>/SetupTasks/<Name of the Setup Task>/<FDFSM_INP_ATTRIBUTE_VALUE>.zip

Notes

If the Name of the Setup Task cannot be determined, then FDFSM_INP_TASK_CODE will be used instead.

All spaces in FDFSM_INP_ATTRIBUTE_VALUE will be replaced with underscore.

All double number signs (##) in FDFSM_INP_ATTRIBUTE_VALUE will be replaced with double underscore.

Example directory structure. Download folder in this example is "SAAS-FSM". Notice the CSV file packages, zip files, are under the "SetupTasks" folder if no scope fields (Business Object Codes, Attribute Name, and Attribute Value) are provided, otherwise, they will appear at the deepest level in the directory structure.


  • No labels