Add Custom Action Fields to a Layout

Custom action payload fields collect values that the add-in sends to the service when a business user performs a custom action. For example, a reject action might include payload fields for a reason code and notes.

Where you add payload fields depends on the custom action type:

• For an item-level custom action, add payload fields to the Table layout or to the table part of a Form-over-Table layout. Business users perform the action on one or more existing rows.
• For a collection-level custom action, add payload fields to an Action Table layout when business users need to create multiple action request rows, each with its own payload values.

If a custom action includes object-based payload fields with subfields, add the subfields as individual columns.

You can add payload fields for a custom action even if the action is hidden from business-user action pickers. Adding payload fields to a layout intentionally exposes that action in the layout workflow so business users can provide values and mark rows for that action.

Use the task that matches your layout type:

• For an item-level custom action in a Table layout or the table part of a Form-over-Table layout, see Add Custom Action Fields to a Table Layout.
• For a collection-level custom action in an Action Table layout, see Add Custom Action Fields to an Action Table Layout.

To review or edit custom action and payload field properties before adding fields to a layout, see Custom Action Configuration. For an overview of custom actions, see Custom Actions.