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

...

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.

...

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

@before 7.0.0.3 This JSON format is preceded by FSMSetupTasks-NEW.json as using this format will only allow for one export criteria to be configured. We suggest using the keys ExportCriteria and FilterCriteria instead. However, keep in mind using this format will add an additional part in the path. More on this later.

Code Block
languagejava
{
  "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

...

)

...

.

...

...

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.

FSMSetupTasks-NEW.json

ExportCriteria and FilterCriteria are supported in the json file. The previous format is still supported, but the new format This will allow for multiple export or filter criteria to be configured. If both formats exists, then the new format will take precedence.

Code Block
languagejava
{
  "tasks": 
  [
	{
      "TaskCode" : "XLE_MANAGE_LEGAL_ENTITY",
	  "ExportCriteria": [
        {
          "BusinessObjectCode" : "XLE_ENTITY_PROFILE",
          "AttributeName" : "LegalEntityIdentifier",
          "AttributeValue" : "LE_AU_01",
        }
      ]
    },
	{
      "TaskCode" : "PAY_MANAGE_FAST_FORMULA",
      "FilterCriteria": [
	  	{
          "BusinessObjectCode" : "FF_FORMULA",
          "Operator" : "Equals",
          "AttributeName" : "FormulaName",
          "AttributeValue" : "MANAGER RANGE OF SCHEDULED HOURS",
        }
	  ]
    }
  ]
}

The JSON objects within the "tasks" array can contain these 7 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

ExportCriteria

No*

List of criteria objects applied at export time. This is configured in the same fashion as the export criteria on a packaged-based FSM project, see https://flexagon.atlassian.net/wiki/spaces/FD80/pages/10556413502/Oracle+SaaS+FSM+Object+Type+-+Setup+Task#Export-Criteria for more details.

Each export criteria object requires the following key-value pairs:

  • BusinessObjectCode

  • AttributeName

  • AttributeValue

If any of the keys or values are missing csvDownloadAdvanced will throw a validation error.

FilterCriteria

No*

List of criteria object applied post export for additional filtering. This is configured in the same fashion as the filter criteria configured on a packaged-based FSM project, see https://flexagon.atlassian.net/wiki/spaces/FD80/pages/10556413502/Oracle+SaaS+FSM+Object+Type+-+Setup+Task#Filter-Criteria for more details.

Each filter criteria object requires the following key-value pairs:

Another JSON format shown below will only allow for one export criteria to be configured. We suggest using the keys ExportCriteria and FilterCriteria instead. However, keep in mind using this format will add an additional part in the path. More on this later. If both formats exists, then the format explained above will take precedence.

Code Block
languagejava
{
  "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.

Download Folder Structure

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

Info

If the new JSON format is used with ExportCriteria and FilterCriteria, then the ValueSets, Lookups, Flexfields, and FastFormulas part will not be added to the path. This is both for simplicity and only the listed object types do not support filter criteria on a FSM project.

...