ACU.EXPANDOBJECTRANGE

Overview

The ACU.EXPANDOBJECTRANGE function returns the full names of Acumatica DAC objects that match a search expression, sorted alphabetically. Use it to find the exact object name to use in ACU.QUERY and ACU.OBJECTDEFINITION, and to check which objects require a filter in ACU.QUERY.

Syntax

=ACU.EXPANDOBJECTRANGE(
    ConnectionName,
    Object,
    IncludeDetails
)

Arguments

Argument	Required/Optional	Description
`ConnectionName`	Optional	Provide one of the following values: Connection name as defined in Connection Manager. Velixo range expression defining a set of connection names. An array of settings as described in the Multiple connections per formula article. We recommend using the VX.SETTINGS function to construct the array. OR Omit the argument to return results for all compatible connections with default aggregation settings.
`Object`	Optional	A search expression for filtering objects, using Velixo range expressions. The expression is matched against the full object name, including the namespace (for example, `PX.Objects.AR.ARAdjust`). Short names such as `ARAdjust` don't match. To find objects by part of their name, use the `like` syntax with the `%` wildcard: `like PX.Objects.AR.%` returns all objects in the `PX.Objects.AR` namespace. `like %.ARAdjust` returns every object with the short name `ARAdjust`, in any namespace. If no object matches, the function returns `#VALUE!` with the message No 'Object' matches requested value or range. If you omit this argument, the function returns all objects.
`IncludeDetails`	Optional	Accepted values: `TRUE`, `FALSE` Default value: `FALSE` If set to `TRUE`, the result includes a header row and a second column, Required Filter Field. This column shows the field you must filter on when you query the object with ACU.QUERY, and is empty for objects that don't require a filter. See Objects that require a filter in the ACU.QUERY article. If set to `FALSE`, the function returns a single column of object names without a header.

Output

The function returns the full names of matching objects, including the namespace, sorted alphabetically. Sorting ignores case. If IncludeDetails is set to TRUE, the result also includes a header row and the Required Filter Field column.

Examples

Return all objects

=ACU.EXPANDOBJECTRANGE(
    "Acumatica"
)

Description: Returns a list of objects available for the Acumatica connection.

Result:

Return objects in a namespace

=ACU.EXPANDOBJECTRANGE(
    "Acumatica",
    "like PX.Objects.AR.%"
)

Description: Returns all objects in the PX.Objects.AR namespace.

Result:

Find the full name of an object

=ACU.EXPANDOBJECTRANGE(
    "Acumatica",
    "like %.ARAdjust"
)

Description: Returns every object with the short name ARAdjust. In this example, the result is PX.Objects.AR.ARAdjust and PX.Objects.CA.Light.ARAdjust. Because the short name matches two objects, use one of the full names in ACU.QUERY.

Result:

Check which objects require a filter

=ACU.EXPANDOBJECTRANGE(
    "Acumatica",
    "like %BalanceAtDate",
    TRUE
)

Description: Returns objects whose names end with BalanceAtDate, with a column showing the field each one must be filtered on in ACU.QUERY.

Result: