You can add a column to your importer directly through the UI of your Fuse account, or you can do so in code using the documentation below.

The Integer column type accepts whole numbers (integers) as input. It supports functionalities such as:

  • Validate that input is greater than or less than a certain number
  • Round values to the nearest integer

addColumn Function

The addColumn function accepts an object as an argument.

  • internal_key (String) - required: The internal key used to access a column’s value.
  • label (String) - required: The user-facing column label that is shown in the interface.
  • column_type (String) - required: Should be “integer”.
  • required (String) - required: Whether or not the column is required.
  • position (Optional): The position or order of the column.
  • unique (Optional): Whether values should be unique.
  • validations (Optional): An array of built-in data validations. See Built-in Integer Validations.
  • transformations (Optional): An array of built-in data transformations. See Built-in Integer Transformations.

Example Code

  • JavaScript

  • TypeScript

  const importer = new FuseImporter(organizationApiKey, importerId);

  const validations = [
    {
      validation_type: "less_than",
      message: "Must be less than 10",
      options: {
        max: 10,
      },
    },
  ];

  const transformations = [
    {
      validation_type: "ceiling",
    },
  ];

  importer.addColumn({
    internal_key: "age",
    label: "Age",
    column_type: "integer",
    required: true,
    position: 1,
    validations: validations,
    transformations: transformations,
  });

  importer.show();

Built-in Integer Validations

The addColumn object accepts an array of validations. Each validation has three properties:

  • validation_type: the name of the validation
  • message: the message showed to the end user if the validation fails
  • options: options for the specific validation type

The validations property accepts an array of objects that contains these possible values: validation_type, message and options. As the example below:

validations: [
  {
    validation_type: "less_than",
    message: "Must be less than 10",
    options: {
      max: 10,
    },
  },
];

less_than

Specifies that the value must be less than a certain number.

validations: [
  {
    validation_type: "less_than",
    message: "Must be less than 10",
    options: {
      max: 10,
    },
  },
];

greater_than

Specifies that the value must be greater than a certain number.

validations: [
  {
    validation_type: "greater_than",
    message: "Must be greater than 10",
    options: {
      min: 10,
    },
  },
];

even

Specifies that the value must be even.

validations: [
  {
    validation_type: "even",
    message: "Must be an even number",
  },
];

odd

Specifies that the value must be odd.

validations: [
  {
    validation_type: "odd",
    message: "Must be an odd number",
  },
];

regex

Specifies that the value must match a regex

validations: [
  {
    validation_type: "regex",
    message: "Must not have a leading zero",
    options: {
      pattern: /^([+-]?[1-9]\d*|0)$/,
    },
  },
];

Built-in Integer Transformations

The options property of addColumn accepts an array of transformations. For the integer transformations, you can specify one property:

  • transformation_type: the name of the transformation

The transformations property accepts an array of objects that contains these possible values: transformation_type. As the example below:

transformations: [
  {
    transformation_type: "floor",
  },
];

round

The round transformation rounds the integer values in the column to the nearest whole number. For example, 36.6 becomes 37.

transformations: [
  {
    transformation_type: "round",
  },
];

floor

The floor transformation rounds down the integer values in the column to the nearest whole number that is less than or equal to the original value. For example, 9.8 becomes 9.

transformations: [
  {
    transformation_type: "floor",
  },
];

ceiling

The ceiling transformation rounds up the integer values in the column to the nearest whole number that is greater than or equal to the original value. For example, 9.2 becomes 10.

transformations: [
  {
    transformation_type: "ceiling",
  },
];