Woodshop for old agent generation
Try the new agent generation
  • What is woodshop
  • How to's
    • Smart Relationship
      • GetIdsFromRequest
    • Smart views
      • Display a calendar view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
      • Create a dynamic calendar view for an event-booking use case
    • Configure environment variables
      • NodeJS/Express projects
    • Elasticsearch Integration
      • Interact with your Elasticsearch data
      • Elasticsearch service/utils
      • Another example
    • Zendesk Integration
      • 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 integration
      • Display Dwolla customers
      • Display Dwolla funding sources
      • Display Dwolla transfers
      • Link users and Dwolla customers
      • Dwolla service
    • Make filters case insensitive
    • Use Azure Table Storage
    • Create multiple line charts
    • Create Charts with AWS Redshift
    • View soft-deleted records
    • Send Smart Action notifications to Slack
    • Authenticate a Forest Admin API against an OAuth protected API Backend
    • Translate your project into TypeScript
      • V8
        • Migrate Mongoose files
        • Migrate Sequelize files
      • v7
        • Migrate Mongoose files
        • Migrate Sequelize files
      • v6
    • Geocode an address with Algolia
    • Display/edit a nested document
    • Send an SMS with Zapier
    • Hash a password with bcrypt
    • Display a customized response
    • Search on a smart field with two joints
    • Override the count route
    • Make a field readOnly with Sequelize
    • Hubspot integration
      • Create a Hubspot company
      • Display Hubspot companies
    • Impersonate a user
    • Import data from a CSV file
    • Import data from a JSON file
    • Load smart fields using hook
    • Pre-fill a form with data from a relationship
    • Re-use a smart field logic
    • Link to record info in a smart view
    • Display data in html format
    • Upload files to AWS S3
    • Display AWS S3 files from signed URLs
    • Prevent record update
    • Display, search and update attributes from a JSON field
    • Add many existing records at the same time (hasMany-belongsTo relationship)
    • Track users’ logs with morgan
    • Search on relationship fields by default
    • Export related data as CSV
    • Run automated tests
  • Forest Admin Documentation
Powered by GitBook
On this page
  • Requirements
  • How it works
  • Directory: /models
  • Directory: /forest
  • Directory: /routes

Was this helpful?

  1. How to's

Import data from a JSON file

PreviousImport data from a CSV fileNextLoad smart fields using hook

Last updated 3 years ago

Was this helpful?

This example shows you how to implement a smart action to upload a JSON file. Here an activities model has a details field of the type JSON. This field should contain information from a JSON file.

Requirements

  • An admin backend running on forest-express-sequelize

How it works

Directory: /models

This directory contains the activities.js file where the activities model is declared.

module.exports = (sequelize, DataTypes) => {
  const { Sequelize } = sequelize;

  const Activities = sequelize.define('activities', {
    details: {
      type: DataTypes.JSONB,
    },
    startDate: {
      type: DataTypes.DATE,
    },
    finishDate: {
      type: DataTypes.DATE,
    },
  }, {
    tableName: 'activities',
    underscored: true,
    timestamps: false,
    schema: process.env.DATABASE_SCHEMA,
  });

  return Activities;
};

Directory: /forest

This directory contains the activities.js file where the smart action Upload JSON is declared.

You need to specify that the widget file picker is applicable to the input field used to upload the file.

activities.js
const { collection } = require('forest-express-sequelize');

collection('activities', {
  actions: [
    {
      name: 'Upload JSON',
      type: 'single',
      fields: [{
        field: 'json',
        widget: 'file picker',
      }],
    },
  ],
  fields: [],
  segments: [],
});

Directory: /routes

This directory contains the activities.js file where the logic of the smart action is implemented.

activities.js
const express = require('express');
const { activities } = require('../models');

const router = express.Router();

router.post('/actions/upload-json', (request, response) => {
  const [activityId] = new RecordsGetter(activities, req.user, req.query).getIdsFromRequest(request);
  // Get the raw base64 file => if your field is a string and you want to insert the JSON as a base64 to use the file viewer, this is the value you want to save in the database
  const rawFile = req.body.data.attributes.values.json;
  // Trim the base64 string to delete the prefix
  const rawFileCleaned = rawFile.replace('data:application/json;base64', '');
  // Get json as string from base64 string
  const stringFile = Buffer.from(rawFileCleaned, 'base64').toString('utf8');
  // Check that you can properly parse json from the string obtained

  let jsonFile
  try {
    jsonFile = JSON.parse(stringFile);
  } catch (error) {
    return res.status(400).send({ error: 'not a correctly formatted json file' });
  }

  // Find and update the current record's details field with the json file as a string
  return activities.update({
    details: jsonFile
  },{
    where: {
      id: activityId,
    },
  })
    .then(() => {
      return res.send({ success: 'record updated!' });
    })
    .catch((e) => {
      console.error(e);
      return res.status(400).send({ error: 'could not update file' });
    });
});

module.exports = router;