Notes on Custom Actions

Here are some things to keep in mind when using custom actions:

• Custom actions are not supported for pending Create rows or form in Create mode.
• Custom actions defined in the OpenAPI service metadata document that have request payload schema members that match business object fields are unlikely to function properly.
• Oracle ADF REST Resource service OpenAPI service metadata documents do not indicate which custom action request payload fields are required. You can use the Business Object Editor to adjust the Required property on payload fields. See Custom Action Configuration.
• Oracle ADF REST Resource services do not return the updated row. As a result, you need to download before making further changes.
• Custom action payload fields must be simple scalar types. Complex objects or maps are not supported.
• The add-in handles custom action results automatically. Here is how it processes the "result" member of the REST response for custom actions that aren't row status custom actions:
  • Simple scalar values are displayed verbatim
  • The first level of JSON objects and arrays are unpacked
  • Deeper levels of JSON are displayed verbatim
  • If there is a null value in an object or array, a "null" string is shown in the results. If the value of the result member is null, then the action result is suppressed.

  Note:

  Row status custom actions have their own handling based on the response schema in Row Status Custom Action Response Schema.
• To use custom actions with the VBBO REST framework, you will need to define an Object Function for each custom action in the business object. In those Object functions, be sure to enable Callable by External System. See Object Functions for Business Objects.
• Row status custom actions must meet these requirements:
  • Must be a row-level custom action
  • Must not change row state, field values, and so on.
  • Must return row status information following the expected row status custom action schema. See Row Status Custom Action Response Schema.
• Row status custom actions can only be triggered automatically in Table layouts.