Entity Range Function (FSN.Range.Entities)
Entity Range Function (FSN.Range.Entities)
The FSN.Range.Entities function returns a dynamic array that can be used to quickly build out worksheets that segment data based upon the entity. Entities in NetSuite can be many different types, such as Company, Contact, Customer, Employee, Generic Resource, Group, Other Name, Partner, Project, Project Template, and Vendor.
Finsyte provides additional range functions for each type of corresponding entity that may be more appropriate depending on your use case.
The syntax for the function is:
| Argument Name | Input Information | Required | Default Value |
|---|---|---|---|
| Include Filter | Specifies the entities to include. Multiple values can be specified by another dynamic array (e.g., using a named range, specifying a range of cells like E1:E10, etc) or concatenated as a string using the ^ character. Additionally, if the values are numeric wildcards and range values can be used such as 100-200, 10*, or 1*-20?0. | No | Include all entities |
| Exclude Filter | Specifies the entities to exclude. Values can be specified as they are in the Include Filter | No | Exclude none |
| Subsidiary | Specifies the subsidiary to use to determine the entities to return. Only entities that are valid for the subsidiary are returned. | No | Does not filter by subsidiary |
| Include Blank | Determines whether or not to include the <No Entity> explicit blank value in the list | No | TRUE |
| Level | Specifies the maximum level of the hierarchy to return. A value of 2 will return all levels <= 2 | Includes all levels | |
| Include Inactive | Specifies whether or not to return entities marked as IsInactive=T in NetSuite | FALSE (Excludes inactive) | |
| Include Rollup | Include rollup value (Hierarchy) for values with children | TRUE (parent rollup Hierarchy values are returned) | |
| Rollup Only | If TRUE, then only top-level rollup values are returned | No | FALSE |
| Horizontal | Controls whether the returned dynamic array spills vertically or horizontally. This values is useful when creating reports based on entities, where values are specified in a single row across the sheet. | No | FALSE (returns a vertical list) |
| Rollup First | When TRUE, returns the rollup (Hierarchy) values before the children. When false, the rollup value is returned after the children | No | TRUE (Rollup value is returned first) |
Remarks
- Review the Function filter syntax for selecting ranges as needed.
- #SPILL! may appear in the array function cell when the resulting array determined by your parameters will not fit in the provided Excel area.
![NOTE] It is recommended that rather than utilizing the entire Entities Range function, a sub-Entities range function is selected from the list (review description at the top).