Include/exclude models - Forest Documentation

By default, all models declared in your app are analyzed by the Forest agent in order to display them as collections in your admin panel. You can exclude some of them from the analysis to never send their metadata to Forest. By doing this, these models will therefore never be available in your admin panel. To do so, add the following code to either define which models are included or excluded.

SQL
Mongoose
Rails
Django

Include models

...

app.use(require('forest-express-sequelize').init({
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  objectMapping,
  connections,
  includedModels: ['customers']
}));

...

Exclude models

...

app.use(require('forest-express-sequelize').init({
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  objectMapping,
  connections,
  excludedModels: ['documents', 'transactions']
}));

...

Include models

...

app.use(require('forest-express-mongoose').init({
  modelsDir: __dirname + '/models',
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  sequelize: require('./models').sequelize,
  includedModels: ['customers']
}));

...

Exclude models

...

app.use(require('forest-express-mongoose').init({
  modelsDir: __dirname + '/models',
  envSecret: process.env.FOREST_ENV_SECRET,
  authSecret: process.env.FOREST_AUTH_SECRET,
  sequelize: require('./models').sequelize,
  excludedModels: ['documents', 'transactions']
}));

...

ForestLiana.env_secret = Rails.application.secrets.forest_env_secret
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret

# ...

# in the [] you may add the precise list of all models you want to see in Forest
ForestLiana.included_models = ['Customer'];

# or second possibility below :

# in the [] you may add the precise list of all models you do not want to see in Forest
ForestLiana.excluded_models = ['Document', 'Transaction'];

# ...
FOREST = {
    'FOREST_ENV_SECRET': os.environ.get('FOREST_ENV_SECRET'),
    'FOREST_AUTH_SECRET': os.environ.get('FOREST_AUTH_SECRET'),
    # in the [] you may add the precise list of all models you want to see in Forest
    'INCLUDED_MODELS': ['Customer']
    # in the [] you may add the precise list of all models you do not want to see in Forest
    'EXCLUDED_MODELS': ['Customer', 'Transaction'],
}

​Include models

​Exclude models

​Include models

​Exclude models

Include models

Exclude models

Include models

Exclude models