Value

This is the official documentation of the agent_ruby Ruby agent.

Value Chart example

Value Charts display a single numerical value.

They can be added to a Dashboard using the addChart method on the agent object

include ForestAdmin::Types

@create_agent.add_chart('monthlyRecuringRevenue') do |context, result_builder|
  aggregation = Aggregation.new(operation: 'Sum', field: 'amount')
  filter = Filter.new(condition_tree: ConditionTreeLeaf.new('status', Operators::EQUAL, 'paid'))
  result = context.datasource.get_collection('payment').aggregate(filter, aggregation)

  result_builder.value(result[0]['value'])
end

# DSL syntax
@create_agent.chart :monthlyRecuringRevenue do
  aggregation = Aggregation.new(operation: 'Sum', field: 'amount')
  filter = Filter.new(condition_tree: ConditionTreeLeaf.new('status', Operators::EQUAL, 'paid'))
  result = context.datasource.get_collection('payment').aggregate(context.caller, filter, aggregation)

  value result[0]['value']
end

Or to the "Analytics" Tab of a Collection using the addChart method on the collection object

include ForestAdmin::Types

@create_agent.customize_collection('customer') do |collection|
  collection.add_chart('monthlyRecuringRevenue') do |context, result_builder|
    aggregation = Aggregation.new(operation: 'Count', field: 'id')
    filter = Filter.new(
      condition_tree: ConditionTreeBranch.new(
        'And',
        [
          ConditionTreeLeaf.new('status', Operators::EQUAL, 'paid'),
          ConditionTreeLeaf.new('customer:id', Operators::EQUAL, context.get_record_id)
        ]
      )
    )
    result = context.datasource.get_collection('payment').aggregate(filter, aggregation)

    result_builder.value(result[0]['value'])
  end
end

# DSL syntax
@create_agent.collection :customer do |collection|
  collection.chart :monthlyRecuringRevenue do
    aggregation = Aggregation.new(operation: 'Count', field: 'id')
    filter = Filter.new(
      condition_tree: ConditionTreeBranch.new(
        'And',
        [
          ConditionTreeLeaf.new('status', Operators::EQUAL, 'paid'),
          ConditionTreeLeaf.new('customer:id', Operators::EQUAL, context.record_id)
        ]
      )
    )
    result = context.datasource.get_collection('payment').aggregate(context.caller, filter, aggregation)

    value result[0]['value']
  end
end

Optionally, an older value can be provided to the resultBuilder to display a growth percentage on the top right of the widget as in the following Chart display:

Value chart with percentage example

Traditional Syntax

Using full context methods with add_chart:

@create_agent.add_chart('appointments') do |_context, result_builder|
  result_builder.value(784, 760)
end

DSL Syntax

Using simplified DSL with chart:

@create_agent.chart :appointments do
  value 784, 760
end