Static Forms

This is the official documentation of the @forestadmin/agent Node.js agent.

Very often, you will need to ask for user inputs before triggering the logic behind an action.

For example, you might want to specify a reason if you want to block a user account. Or set the amount to charge a user’s credit card.

Action Form displayed on Forest Admin

Field Configuration

More information about the ActionField type can be found on our API Reference ↗.

Properties

Fields are configurable using the following properties:

Property	Usage	Expected value	Description
type	required	Boolean, Date, Dateonly, Enum, Json, Number, NumberList, EnumList, String, StringList, File, FileList and Collection	Set the type of the field ↗.
label	required	string	Set the label of the field.
id	optional	string	Set the id of the field. The is used internally and to access values from the context. If not set the label will be used.
description	optional	string	Set the description of the field.
isRequired	optional	boolean	Make the field required (default false).
defaultValue	optional	any	Set the default value of the field.
isReadOnly	optional	boolean	Make the field read-only (default false).
enumValues	required when type is Enum	array of strings	Change the list of possible values of the field when type is Enum.
widget	optional	null, AddressAutocomplete, Checkbox, CheckboxGroup , ColorPicker, CurrencyInput,DatePicker, Dropdown, FilePicker, JsonEditor, NumberInput, NumberInputList, RadioGroup, RichText, TextArea, TextInput, TextInputList, TimePicker, UserDropdown	Set the widget to use for the field. More info on the dedicated page.

agent.customizeCollection('customer', collection => {
  collection.addAction('Charge credit card', {
    scope: 'Single',
    form: [
      {
        label: 'amount',
        description: 'The amount (USD) to charge the credit card. Example: 42.50',
        type: 'Number',
        isRequired: true,
      },
    ],
    execute: async (context, resultBuilder) => {
      // Retrieve values entered in the form and columns from the selected record.
      const { amount } = context.formValues;
      const { stripeId, address } = await context.getRecord([
        'stripeId',
        'address:country',
      ]);

      /* ... Charge the credit card here ... */
      return resultBuilder.success('Amount charged!');
    },
  });
});

References to records

Reference widget on an action form

When using the Collection type, you can create a reference to a record of any collection.

The value of the field will be the primary key of the selected record.

Note that the value will be stored in an array as the target collection may be using a composite primary key. When not using a composite primary key, the array can be assumed to contain a single value.

agent.customizeCollection('ticket', collection => {
  collection.addAction('Assign ticket', {
    scope: 'Single',
    form: [
      {
        label: 'Assignee',
        description: 'The user to assign the ticket to',
        type: 'Collection',
        collectionName: 'user',
        isRequired: true,
      },
    ],
    execute: async (context, resultBuilder) => {
      // Retrieve user id from the form
      // (assuming the user collection has a single primary key)
      const [userId] = context.formValues.Assignee;
    },
  });
});