Python Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting started
    • How it works
    • Quick start
      • Flask
      • Django
    • Create your agent
    • Troubleshooting
    • Migrating legacy agents
      • Pre-requisites
      • Recommendations
      • Migration steps
      • Code transformations
        • API Charts
        • Live Queries
        • Smart Charts
        • Route overrides
        • Smart Actions
        • Smart Fields
        • Smart Relationships
        • Smart Segments
  • Data Sources
    • Getting Started
      • Collection selection
      • Naming conflicts
      • Query interface and Native Queries
        • Fields and projections
        • Filters
        • Aggregations
    • Provided data sources
      • SQLAlchemy
      • Django
        • Polymorphic relationships
    • Write your own
      • Translation strategy
        • Structure declaration
        • Capabilities declaration
        • Read implementation
        • Write implementation
        • Intra-data source Relationships
      • Contribute
  • Agent customization
    • Getting Started
    • Actions
      • Scope and context
      • Result builder
      • Static Forms
      • Widgets in Forms
      • Dynamic Forms
      • Form layout customization
      • Related data invalidation
    • Charts
      • Value
      • Objective
      • Percentage
      • Distribution
      • Leaderboard
      • Time-based
    • Fields
      • Add fields
      • Move, rename and remove fields
      • Override binary field mode
      • Override writing behavior
      • Override filtering behavior
      • Override sorting behavior
      • Validation
    • Hooks
      • Collection hook
      • Collection override
    • Pagination
    • Plugins
      • Write your own
    • Relationships
      • To a single record
      • To multiple records
      • Computed foreign keys
      • Under the hood
    • Search
    • Segments
  • Frontend customization
    • Smart Charts
      • Create a table chart
      • Create a bar chart
      • Create a cohort chart
      • Create a density map
    • Smart Views
      • Create a Map view
      • Create a Calendar view
      • Create a Shipping view
      • Create a Gallery view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
  • Deploying to production
    • Environments
      • Deploy on AWS
      • Deploy on Heroku
      • Deploy on GCP
      • Deploy on Ubuntu
    • Development workflow
    • Using branches
    • Deploying your changes
    • Forest Admin CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:create
      • environments:reset
      • deploy
  • Under the hood
    • .forestadmin-schema.json
    • Data Model
      • Typing
      • Relationships
    • Security & Privacy
Powered by GitBook
On this page
  • Code cheatsheet
  • Steps
  • Step 1: Calling add_action for the appropriate collection
  • Step 2: Porting the form definition
  • Step 3: Porting the route to the new agent execute function
  • Step 4: Porting Smart Action hooks

Was this helpful?

  1. Getting started
  2. Migrating legacy agents
  3. Code transformations

Smart Actions

PreviousRoute overridesNextSmart Fields

Last updated 7 months ago

Was this helpful?

This is the official documentation of the forestadmin-agent-django and forestadmin-agent-flask Python agents.

In legacy agents declaring a Smart Action was a two-step process:

  • First, you had to declare by changing the parameters of the collection function in the appropriate app/forest/*.python file.

  • Then, you had to implement the action by creating a route handler in the appropriate app/urls.py/app/views.py file.

    In the new agent, the process is simplified to a single step.

You can find the full documentation of action customization .

Code cheatsheet

Legacy agent
New agent

type: 'single' type: 'bulk' type: 'global'

scope: 'Single' scope: 'Bulk' scope: 'Global'

download: True

generate_file: True

reference: 'otherCollection.id'

{ type: 'Collection', collection_name: 'otherCollection' }

enums: ['foo', 'bar']

{ type: 'Enum', enum_values: ['foo', 'bar'] }

Request object

context.get_record_ids()

Response object

return result_builder.success(...) return result_builder.error(...) ...

Steps

Step 1: Calling add_action for the appropriate collection

Start by calling the add_action function on the appropriate collection and passing the appropriate parameters.

Most notably, you will need to pass:

  • type should become scope

    • Note that the values are now capitalized (e.g. single becomes Single)

    • Legacy agents defaulted to 'bulk' if no type was specified. The new agent requires you to specify the scope.

  • download should become generate_file. This is still a boolean and the same value can be passed.

  • endpoint and httpMethod should be removed. The agent will now automatically handle the routing.

from django_forest.utils.collection import Collection

class CompanyForest(Collection):
    def load(self):
        self.actions = [
            {"type": "single", "name": "Mark as Live"},
        ]
from forestadmin.datasource_toolkit.decorators.action.context.single import ActionContextSingle
from forestadmin.datasource_toolkit.decorators.action.result_builder import ResultBuilder

def mark_as_live(context: ActionContextSingle, result_builder: ResultBuilder):
    pass

agent.customize_collection("Company").add_action("Mark as live", {
        "scope": "Single",
        "execute": mark_as_live,
    }
)

Step 2: Porting the form definition

Forms are now defined in the form property of the action.

You can simply copy the field's definition from the legacy agent to the new agent with the following differences:

  • fields should become form.

  • widget choice is no longer supported. A default widget will be used depending on the field type.

  • hook can be removed, those will be handled by the new agent automatically.

  • reference no longer exists. Use { type: "Collection", collection_name: '... } instead.

  • enums no longer exist. Use { type: "Enum", enum_values: ['...'] } instead.

from django_forest.utils.collection import Collection

class CompanyForest(Collection):
    def load(self):
        self.actions = [
            {
                "type": "single",
                "name": "Charge credit card",
                "fields": [
                    {"field": "amount", "type": "number", "isRequired": True},
                ]
            },
        ]
agent.customize_collection("Customer").add_action("Charge credit card",{
    "scope": "Single",
    "form": [
        {
            "label": "amount",
            "type": "Number",
            "description": "The amount (USD) to charge the credit card. Example: 42.50",
            "is_required": True
        }
    ],
    "execute": lambda ctx, result_builder: pass
})

Step 3: Porting the route to the new agent execute function

In the legacy agent, users had to implement the action by creating a route handler in the appropriate app/urls.py file.

This is no longer needed as the new agent provides a context object that contains all the information that is needed to implement the action.

When porting the route handler to the new agent, you will need to:

  • Move the body of the route handler to the execute function of the action.

  • Replace self.get_ids_from_request() call with context.get_record_ids().

from django.http import HttpResponse
from app.model import Company

class MarksLiveAction(ActionView):
    def post(self, request, *args, **kwargs):
        ids = self.get_ids_from_request(request, self.Model)
        company = Company.objects.filter(id__in=ids)[0]
        company.status = "live"
        company.save()

    return HttpResponse(status=204)
from forestadmin.datasource_toolkit.interfaces.query.filter.unpaginated import Filter
from forestadmin.datasource_toolkit.interfaces.query.condition_tree.nodes.leaf import ConditionTreeLeaf
from forestadmin.datasource_toolkit.decorators.action.context.single import ActionContextSingle
from forestadmin.datasource_toolkit.decorators.chart.result_builder import ResultBuilder

async def mark_as_live(context: ActionContextSingle, result_builder: ResultBuilder):
      company_id = await context.get_record_id()
      await context.collection.update(
          { "status": 'live' },
          Filter(
              {"condition_tree": ConditionTreeLeaf("id", "equal", company_id)}
          )
      )

      return result_builder.success('Company is now live!')

agent.customize_collection('companies').addAction('Mark as Live', {
        "scope": "Single",
        "execute": mark_as_live
    }
)

Step 4: Porting Smart Action hooks

Load hooks and change hooks have been replaced on the new agent by the possibility to use callbacks in the form definition.

Here is an example of a load hook where the default value of a field is set to 50 euros converted into dollars:

from django_forest.utils.collection import Collection

class CustomersForest(Collection):
    def load(self):
        self.actions = [
            {
                "type": "single",
                "name": "Charge credit card",
                "fields": [
                    {
                        "field": "amount",
                        "type": "number",
                    },
                ],
                "hooks": {
                    "load": self.send_invoice_load_hook,
                },
            },
        ]

    def send_invoice_load_hook(self, fields, request, *args, **kwargs):
        amount_field = next((x for x in fields if x["field"] == "amount"), None)
        amount_field["value"] = convertEurosIntoDollars(50)
        return fields
from forestadmin.datasource_toolkit.decorators.action.context.single import ActionContextSingle

def amount_default_value(context: ActionContextSingle):
    return convertEurosIntoDollars(50)

agent.customize_collection('customers').add_action('Charge credit card', {
    "scope": "Single",
    "form": [
        {
            "field": 'amount',
            "type": "Number",

            # the function given can also be an async function,
            # it will be automatically awaited
            "default_value": amount_default_value,
            # or a lambda
            # "default_value": lambda context: convertEurosIntoDollars(50),
        },
    ]}
)

And another for a change hook which makes a field required if the value of another field is greater than 100:

from django_forest.utils.collection import Collection

class CustomersForest(Collection):
    def load(self):
        self.actions = [
            {
                "type": "single",
                "name": "Charge credit card",
                "fields": [
                    {
                        "field": "amount",
                        "type": "number",
                        "hook": "on_amount_change",
                    },
                    {
                        "field": "motivation",
                        "type": "string",
                        "is_required": False,
                    },
                ],
                "hooks": {
                    "change": {
                        "on_amount_change": on_amount_change,
                    },
                },
            },
        ]

    def on_amount_change(self, fields, request, changed_field, *args, **kwargs):
        amount_field = next((x for x in fields if x["field"] == "amount"), None)
        motivation_field = next(
            (x for x in fields if x["field"] == "motivation"), None
        )
        motivationField["is_required"] = amount_field["value"] > 100
        return fields
from forestadmin.datasource_toolkit.decorators.action.context.single import ActionContextSingle

async def amount_is_required(context: ActionContextSingle):
    return context.form_values.get("amount", 0) > 100

agent.customize_collection('customers').add_action('Charge credit card', {
    "scope": "Single",
    "form": [
        {
            "field": 'amount',
            "type": "Number",
        },
        {
            "field": 'motivation',
            "type": "String",

            # the function given can also be an async function,
            # it will be automatically awaited
            "is_required": amount_is_required,
            # or a lambda
            # "is_required": lambda context:context.form_values.get("amount", 0)>100,
        },
    ]}
)

Replace return JsonResponse(); calls with return result_builder.success() or return result_builder.error(), or the .

here
appropriate result_builder method