RPC agent

This is the official documentation of the agent_ruby Ruby agent.

An RPC agent exposes its collections to the main agent via RPC protocol.

Installation

Add the gem to your Gemfile:

gem 'forest_admin_rpc_agent'

Then run:

bundle install

Run the installation command with the auth_secret from your main Forest Admin project:

forest_admin_rpc_agent install YOUR_AUTH_SECRET

This command will:

• Create config/initializers/forest_admin_rpc_agent.rb (configuration file with auth secret)

• Create lib/forest_admin_rpc_agent/create_rpc_agent.rb (agent configuration)

• Mount the RPC routes in config/routes.rb

By default, the RPC datasource uses your Forest Admin project's auth_secret. If you specify a custom auth_secret when installing the RPC agent, make sure to use the same value in your main agent's RPC datasource configuration.

Configuration

The generated lib/forest_admin_rpc_agent/create_rpc_agent.rb file contains:

module ForestAdminRpcAgent
  class CreateRpcAgent
    def self.setup!
      datasource = ForestAdminDatasourceActiveRecord::Datasource.new(Rails.env.to_sym)
      @agent = ForestAdminRpcAgent::Agent.instance.add_datasource(datasource)

      @agent.build
    end
  end
end

Customizing collections

You can use all standard customization methods on your RPC agent collections.

Adding a computed field

@agent.customize_collection('Invoice') do |collection|
  collection.add_field('total_with_tax', {
    column_type: 'Number',
    dependencies: ['amount', 'tax_rate'],
    get_values: proc { |records|
      records.map { |r| r['amount'] * (1 + r['tax_rate']) }
    }
  })
end

Adding an action

@agent.customize_collection('Invoice') do |collection|
  collection.add_action('Mark as paid', {
    scope: 'Single',
    execute: proc { |context|
      invoice = context.get_record(['id'])
      Invoice.find(invoice['id']).update!(status: 'paid')
      context.result_builder.success('Invoice marked as paid')
    }
  })
end

Adding a segment

@agent.customize_collection('Invoice') do |collection|
  collection.add_segment('Overdue', proc {
    { field: 'due_date', operator: 'before', value: Date.today }
  })
end

For advanced use cases like defining relations between collections from different RPC agents, see Advanced usage.