Skip to content
  • There are no suggestions because the search field is empty.

How to Utilize the Expand Arrays

This article explains how the Expand Array feature works. It provides steps to utilize the feature, common issues and best practices.

What is in this article

  • What is Expand Arrays
  • Steps to Utilize Expand Arrays
  • Common Issues and Troubleshooting (delete?)
  • Best Practices

What is Expand Arrays

The Expand Arrays feature in HighByte allows users to contextualize each row of an array of objects in an instance attribute.  This feature is particularly useful when dealing with data sources that provide arrays of objects (e.g., JSON arrays from SQL rows), enabling you to handle and process each element individually.

Steps to Utilize Expand Arrays

Prerequisites: Before utilizing the Expand Arrays feature, ensure that your data reference is an array.

 

Enabling Expand Arrays

  1. Navigate to the Instances page in HighByte.
  2. Locate the instance you want to configure and click on it.
  3. Toggle the Expand Arrays feature on by using the flag provided.

 

 Configuring Attributes

  1. In the instance configuration, reference the first element `[0]` of the array for each attribute you want to expand.
  2. Ensure that all referenced arrays have the same cardinality and that the instance is referenced directly (root).

Note: When set to true, the instance will attempt to expand all arrays against the instance’s attributes. This feature is only functional when the base reference is of type array, all referenced arrays have the same cardinality, and the instance is referenced directly (root).

Best Practices

- Always verify that the arrays you are working with in every attribute in the instance have equal cardinality to avoid processing errors.

- Reference arrays directly at the root level for the Expand Arrays feature to function correctly.

 

TODO: Create a project to demo expand arrays