Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting Started
    • Quick start
    • Development workflow
  • Reference Guide
    • How it works
      • Environments
      • Developing on Forest Admin
        • Using branches
        • Deploying your changes
        • Forest CLI commands
          • init
          • login
          • branch
          • switch
          • set-origin
          • push
          • environments:reset
          • environments:create
          • deploy
          • schema:diff [beta]
        • Express packages
    • Models
      • Enrich your models
      • Relationships
        • Create a Smart relationship
          • GetIdsFromRequest
        • Smart Relationship Examples
          • Smart hasMany relationship in mongoDB
    • Actions
      • Create and manage Smart Actions
        • Use a Smart Action Form
        • Use a Smart Action Intent
      • Smart Action Examples
        • Calculate the distance between two string addresses
        • Impersonate a user
        • Create a record with a multiselect through a many-to-many relationship
        • Handle enums with alias labels in a smart action
        • Dropdown with list of values in smart action form
        • Custom dynamic dropdown in a form using smart collections
        • Refresh hasMany relationship in smart action
        • Smart segment to restrict access to an action on a record details view
        • BelongsToMany edition through smart collection
        • Upload files to amazon s3
        • Upload several files with the File Picker
        • Retrieve smart field info in a smart action
        • Smart action to create several records from the input of a single smart action form
        • Add many existing records at the same time (hasMany-belongsTo relationship)
        • Call a webhook with record ids
        • Bulk update records
    • Smart Fields
      • Smart Field Examples
        • Add an HTML credit card as a smart field in a summary view
        • Display field with complex info in html format (rich text editor)
        • Generate signed urls to display S3 files in a smart field
        • Print a status object in a single line field
        • Sort by smart field
        • Sort by smart field that includes value from a belongsTo relationship
        • Add fields destined to the create form
        • Add validation to a smart field edition
        • Display smart field as progress bar using rich text editor
        • Update point geometry field using a smart field and algolia api
    • Smart Collections
      • Examples
        • Create a Smart Collection with Amazon S3
        • Smart relationship between model and stripe cards
        • Create records from a Smart collection
        • Searchable smart collection with records fetched from hubspot API
      • Serializing your records
    • Routes
      • Default routes
      • Extend a route
      • Override a route
    • Integrations
      • Stripe
      • Mixpanel
      • Intercom
      • Elasticsearch
        • Interact with your Elasticsearch data
        • Elasticsearch service/utils
        • Another example
      • Zendesk
        • Authentication, Filtering & Sorting
        • Display Zendesk tickets
        • Display Zendesk users
        • View tickets related to a user
        • Bonus: Direct link to Zendesk + change priority of a ticket
      • Dwolla
        • Display Dwolla customers
        • Display Dwolla funding sources
        • Display Dwolla transfers
        • Link users and Dwolla customers
        • Dwolla Service
      • Razorpay
      • Hubspot
        • Create a Hubspot company
        • Display Hubspot companies
      • Twilio
        • Send an SMS with Twilio and Zapier
      • Azure Table Storage
      • Slack
        • Send Smart Action notifications to Slack
      • Algolia
        • Geocode an address with Algolia
    • 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 dynamic calendar view for an event-booking use case
      • Create a custom moderation view
    • Smart Segments
    • Scopes
      • Create a scope more than one level away based on a Smart field
      • Scope on a smart field extracting a json's column attribute
    • Performance
    • Charts
      • Create an API-based Chart
      • Create a Smart Chart
      • Create Charts with AWS Redshift
  • Extra help
    • Setup
      • Install
      • Connecting Forest Admin to Your Database (Forest Cloud)
      • Forest Admin IP white-listing (Forest Cloud)
      • Why HTTPS is necessary even locally
      • Troubleshooting
      • Prevent permission errors at installation
      • Deploy your admin backend to AWS
      • Deploy your admin backend on Heroku
      • Deploy your admin backend to Ubuntu server
      • Deploy your admin backend to Google Cloud Platform
      • Install Forest Admin on a remote machine
      • Use Forest Admin with a read-only database
      • Configuring CORS headers
      • Running Forest Admin on multiple servers
      • Flatten nested fields (MongoDB)
    • Upgrade
      • Upgrade notes (Rails)
        • Upgrade to v9
        • Upgrade to v8
        • Upgrade to v7
        • Upgrade to v6
        • Upgrade to v5
        • Upgrade to v4
        • Upgrade to v3
      • Upgrade notes (SQL, Mongodb)
        • Upgrade to v9
        • Upgrade to v8
        • Upgrade to v7
        • Upgrade to v6
        • Upgrade to v5
        • Upgrade to v4
        • Upgrade to v3
      • Update your models' definition
      • Monitor your Forest's status
      • Manage your Forest Admin environments programmatically
      • Changing your domain name
      • Migrate to the new role system
      • Push your new version to production
    • Databases
      • Use a demo SQL database
      • Use a demo MongoDB database
      • Populate a postgreSQL database on Heroku
      • Connect to a read replica database
      • Plug multiple schemas
      • Add new databases
      • Manage SQL views
    • Settings
      • Customize your /forest folder
      • Disable automatic Forest Admin schema update
      • Include/exclude models
      • Display extensive logs
      • Laravel specific settings
    • Releases Support
    • Other documentations
Powered by GitBook
On this page

Was this helpful?

  1. Reference Guide
  2. Models
  3. Relationships
  4. Create a Smart relationship

GetIdsFromRequest

PreviousCreate a Smart relationshipNextSmart Relationship Examples

Last updated 1 year ago

Was this helpful?

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

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 v1.

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

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

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 v1.

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

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

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 v3.

If you’re using a Symfony agent, go to the v1 documentation.

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

GetIdsFromRequest

In recent versions of our agents, you may have noticed a new helper, which is getIdsFromRequest. This helper comes alongside the , allowing you to trigger a Smart Action on more records than those displayed in the UI.

Unfortunately, this helper is not compatible with Smart Actions triggered on Smart Relationships. This is due to the Smart Relationship concept. When you create a , you become the owner of the way your data are linked together by overriding the routes. Forest can't retrieve the logic to link the data, this is why you also need to code your own getIdsFromRequest helper. This documentation will guide you through the steps you need to create your own helper.

Let's take an example to illustrate what we want to achieve:

In this case, with have a HasMany Smart Relationship between owners and articles called Liked articles. As you can see, we are about to trigger the Unlike Smart Action on every article the owner liked that corresponds to the filter and the search we configured.

What is the getIdsFromRequest about?

This helper simply takes a query as a parameter (containing your filters, your search, and some other configuration) and then returns the ids corresponding to this query. In other words, based on what the user selects ('select all', 'select current page', ...) this helper is able to return the exact ids the user wants to operate on. With these ids, your will then be able to perform operations related to your smart actions.

4 cases need to be handled there:

  • Select all: each of the related records should be impacted

  • Select all, minus some: each of the related records should be impacted, except specific ones

  • Select current page: each of the listed records should be impacted

  • Select some: only some specific records should be impacted

Only the two first cases need to be handled, because the last two cases consist of a simple list of the ids selected by the user directly in the request. So nothing special to do here.

In conjunction with the previous 4 cases, we also need to handle the filters and the search set up before executing the smart action.

Code Snippet

Please find in the following snippet every of the requirement listed above fulfilled to make the Smart Action work with the Select All feature.

const { PermissionMiddlewareCreator } = require('forest-express-sequelize');
const permissionMiddlewareCreator = new PermissionMiddlewareCreator('articles');

...

// In this function, we want to mimic the getIdsFromRequest behavior,
// Used in conjunction with the "select all record" feature on a smart relationship
async function customGetIdsFromRequest(request) {
  const {
    all_records,
    all_records_ids_excluded,
    parent_collection_id: parentRecordId,
    all_records_subset_query,
    ids,
  } = request.body.data.attributes;

  if (all_records) {
    // In this case, the "select all records" option has been selected.
    // This means that the action we want to trigger needs to be performed
    // On every record
    const options = {
      where: {
        owners_id: parentRecordId,
      },
      attributes: ['id'],
      raw: true,
    }

    // Handle filters on records if any
    if (all_records_subset_query && all_records_subset_query.filters) {
      const filter = await parseFilter(
        JSON.parse(all_records_subset_query.filters),
        Schemas.schemas.articles,
        request.query.timezone
      );

      options.where = { ...options.where, ...filter };
    }

    // Handle the search if any
    if (all_records_subset_query.search) {
      if (options.where.body) {
        options.where.body[Op.like] = all_records_subset_query.search;
      } else {
        options.where.body = { [Op.like]: all_records_subset_query.search };
      }
    }

    if (all_records_ids_excluded && all_records_ids_excluded.length) {
      // In this case, the "select all records" option has been selected but some records
      // has been unselected right after. This means that the action we want to trigger
      // needs to be performed on every relationship, except some specific one
      options['where']['id'] = {
        [Op.notIn]: all_records_ids_excluded
      };
    }

    return (await articles.findAll(options)).map((record) => record.id);
  }

  // In any other cases, the ids selected to perform the
  // smart action on are listed in the "ids" attribute
  return ids;
}

router.post('/actions/Unlike', permissionMiddlewareCreator.smartAction(), async (request, response, next) => {
  const ids = await customGetIdsFromRequest(request);

  // Do whatever you want with the ids here

  response.status(200).send();
})

Explanation of the code:

  • Line 1: If the Select All feature has been used, we need to build a query to concatenate the filter, the search, and the Select All configuration. Otherwise, the ids are already present in the query (see line 58)

  • Line 25: Here is an example to show you how to quickly handle filters, if any

  • Line 36: Here is an example to show you how to handle the search, if any

  • Line 44: Finally, this snippet of code removes any ids that have been unselected by the user after using the Select All feature.

@forestadmin/agent
forestadmin-agent-django
forestadmin-agent-flask
forestadmin/laravel-forestadmin
forestadmin/symfony-forestadmin
'Select All' feature
HasMany Smart Relationship