Use a Smart Action Intent

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Smart Action Intents

What are smart action intents ?

Action intents allows you to redirect your operators from the outside worlds directly to a specific action, by using an url.

This means that your actions can now be accessed directly using a link (saving many clicks), link for which you can specify few parameters so can pre-compute your form with custom values for instance.

All of our action types are supported (Global, Bulk and Single)

Building a smart action intent

Get to the index of the collection you want to share an action from, and retrieve its URl.

For instance, given a project aProject, an environment anEnvironment, a team aTeam and a collection aCollection, the url should look similar to this:

https://app.forestadmin.com/aProject/anEnvironment/aTeam/data/aCollection/index

Base on that url, you can configure the action intent with 3 parameters:

• actionIntent of type string, being the name of the action you want to redirect to.

• actionIntentIds of type array of string, being the IDs of the records you want to execute the action for.

• actionIntentParams of type JSON object, being the params you want to send along your action intent

Please do note that `actionIntentIds` and `actionIntentParams` should be a valid JSON structure

Here is an example of all of these parameters combined:

https://app.forestadmin.com/aProject/anEnvironment/aTeam/data/aCollection/index?actionIntent=anActionName&actionIntentIds=[1,2]&actionIntentParams={"firstParam":"firstValue","secondParam":"secondValue"}

How to use actionIntentParams

`actionIntentParams` should be a valid JSON object

Your parameters provided to the action intent will be passed to your agent over change and load hooks, allowing you to compute any value for your fields based on the provided parameters. You can access those parameters like such:

SQL

/forest/aCollection.js

const { collection } = require('forest-express-sequelize');
const { customers } = require('../models');

collection('aCollection', {
  actions: [{
    name: 'anAction',
    type: 'single',
    fields: [{
      field: 'aField',
      type: 'String',
      hook: 'onValueChange',
    }],
    hooks: {
      change: {
        onValueChange: ({ fields, request }) => {
          const actionIntentParams = request.body.data.attributes.action_intent_params;
          
          ...
          
          return fields;
        }
      },
      load: async ({ fields, request }) => {
        const actionIntentParams = request.body.data.attibutes.action_intent_params;
        
        ...
        
        return fields;
      },
    },
  }],
  ...
});

Mongodb

/forest/aCollection.js

const { collection } = require('forest-express-mongoose');
const { customers } = require('../models');

collection('aCollection', {
  actions: [{
    name: 'anAction',
    type: 'single',
    fields: [{
      field: 'aField',
      type: 'String',
      hook: 'onValueChange',
    }],
    hooks: {
      change: {
        onValueChange: ({ fields, request }) => {
          const actionIntentParams = request.body.data.attributes.action_intent_params;

        ...

          return fields;
        }
      },
      load: async ({ fields, request }) => {
        const actionIntentParams = request.body.data.attibutes.action_intent_params;

      ...

        return fields;
      },
    },
  }],
  ...
});

Rails

lib/forest_liana/a_collection.rb

class Forest::ACollection
  include ForestLiana::Collection

  collection :ACollection

  action 'an_action',
    type: 'single',
    fields: [{
      field: 'a_field',
      type: 'String',
      hook: 'on_value_change',
    }],
    :hooks => {
      :change => {
        'on_value_change' => -> (context) {
          action_intent_params = context[:params][:data][:attributes][:action_intent_params];
          
          ...
          
          return context[:fields];
        }
      }
      :load => -> (context, request) {
        action_intent_params = context[:params][:data][:attributes][:action_intent_params];
        
        ...

        return context[:fields];
      }
    }
    ...
end

How to use actionIntentIds

`actionIntentIds` should be a valid JSON array, or a single id. It is also worth noting that for global action, any provided ids will be skipped. Also, action of type single should be having a single id provided, and bulk action should be passed having many provided

Ids configured in the action intent will be provided as usual within your context. Please refer to this documentation for more details.