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
  • Field Configuration
  • Properties
  • References to records

Was this helpful?

  1. Agent customization
  2. Actions

Static Forms

PreviousResult builderNextWidgets in Forms

Last updated 6 months ago

Was this helpful?

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

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.

Field Configuration

Properties

Fields are configurable using the following properties:

Property
Expected value
Description

type

Set the type of the field.

label

string

Set the label of the field.

id

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

string

Set the description of the field.

is_required

boolean

Make the field required (default false).

is_read_only

boolean

Make the field read-only (default false).

default_value

any

Set the default value of the field.

enum_values

array of strings

Change the list of possible values of the field when type is Enum.

from typing import Union
from forestadmin.datasource_toolkit.decorators.action.context.single import ActionContextSingle
from forestadmin.datasource_toolkit.decorators.action.result_builder import ResultBuilder
from forestadmin.datasource_toolkit.interfaces.actions import ActionResult

async def execute(
    context: ActionContextSingle, result_builder: ResultBuilder
) -> Union[None, ActionResult]:
    record = await context.get_record(['stripeId', 'address:country'])
    form_values = context.form_values

    # ... charge the credit card ...

    return result_builder.success("Amount charged")

agent.customize_collection("Company").add_action("Charge credit card", {
    "scope": "Single",
    "execute": execute,
    "form":[
      {
        "type": "Number",
        "label": "amount",
        "description": "The amount (USD) to charge the credit card. Example: 42.50",
        "is_required": True,
      }
    ],
})

References to records

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.

from typing import Union
from forestadmin.datasource_toolkit.decorators.action.types.actions import ActionSingle
from forestadmin.datasource_toolkit.decorators.action.result_builder import ResultBuilder
from forestadmin.datasource_toolkit.interfaces.actions import ActionResult

async def execute(
    context: ActionContextSingle, result_builder: ResultBuilder
) -> Union[None, ActionResult]:
    # Retrieve user id from the form
    user_id = context.form_values["Assigne"]

agent.customize_collection("Company").add_action("Charge credit card", {
    "form":[
        {
            "label": "Assigne",
            "type": "Collection",
            "description": "The user to assign the ticket to",
            "collection_name": "user",
            "is_required": True,
        }
    ],
    "scope": "Single",
    "execute": execute,
})

Boolean, Date, Dateonly, Enum, Json, Number, String, NumberList, EnumList, StringList, FileList and }

Collection
Action Form displayed on Forest Admin
Reference widget on an action form