Notes on Custom Actions

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

• To perform collection-level custom action requests in bulk, supplying different payload field values for each action request, see Create an Action Table Layout.
• Custom actions are not supported for pending Create rows or form in Create mode.
• ADF REST 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.
• ADF REST services do not return the updated row. As a result, you need to download before making further changes.
• Custom action payload fields can be simple scalar types or object-based fields with subfields. Array-type payload fields 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 is 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 require the “result” schema described 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.