Design SuiteData mapping expressions

Each data mapping formula begins with an equal sign (=) and contains expressions that are a combination of functions, constants, variables, and operators. The formula produces a new value, or a field identifier to select data mapped to an object. For information about the functions available, see Worksheet functions.

Constants

Constants can be logical values, numerical values, or text strings.

Constant

Description

Examples

Boolean

Values are used for Boolean parameters, and are either true or false

TRUE

FALSE

Integer

Positive or negative numbers and 0, written as numbers with no decimal point or apostrophes

4

125

Rational number

Real number values, written as a number with a decimal point and no apostrophes

3.14

-12.0

248.141539

Text

String values enclosed within apostrophes

'Unstyled Wall'

'INTERNAL'

'NOTDEFINED'

Variables

Variables represent data from Vectorworks objects. They can be combined with constants, function results, and other variables by using operators. The variable type (name) is the same as that of the data source type.

Variable

Notation

Examples

Parameters from a plug-in object

'ObjectName'.'ParameterName'

If the parameter is a pop-up field, the variable returns the localized value. To use the universal value instead, use the OBJECTDATA function:

OBJECTDATA('Universal Value', 'Object PIO Name', 'Field Name')

'Door'.'Config'

'Column2'.'Column ID'

'Pilaster2'.'Struct Type'

OBJECTDATA('Universal Value', 'Column2', 'Struct Type')

Vectorworks name

OBJECTDATA('General Name')

OBJECTDATA('General Name')

Data fields from a record

'RecordName'.'FieldName'

If a record by that name isn't attached to the object, the FORMATFIELD function takes the default value for the field: FIRSTNONEMPTY('RecordName'.'FieldName', FORMATFIELD('RecordName','FieldName'))

'MyRecord'.'Price'

'Plant Record'.'Latin Name'

Data fields from styles

Style.'FieldName'

Supported data fields:

Name (the name of the style)

Mark

Function

Description

Exterior (Boolean)

Load-Bearing (Boolean)

Fire Rating

Combustible Construction (Boolean)

Compartmentation (Boolean)

U-Value

Acoustic Rating

Cost Index System

Cost Index Code

Model

Manufacturer

Style.'Function'

Style.'Name'

Style.'Fire Rating'

Data fields from components in wall, slab, or roof styles

Use the appropriate worksheet function, depending on the field desired:

COMPONENTNAME(ComponentIndex)

OBJECTDATA('Component', 'Function', ComponentIndex)

OBJECTDATA('Component', 'Class', ComponentIndex)

COMPONENTTHICKNESS(ComponentIndex)

COMPONENTLAMBDA(ComponentIndex)

COMPONENTUVALUE(ComponentIndex)

To automatically assign the index during the export process, replace the parameter ComponentIndex with T=INDEX. The ExportOptions Pset must be mapped or attached to the object and one of the following property fields must be set to ON: Export by Components or Export Separate Instances.

COMPONENTNAME(1)

OBJECTDATA('Component', 'Class', 1)

OBJECTDATA('Component', 'Function', T=INDEX)

COMPONENTLAMBDA(T=INDEX)

Data fields from materials

Use the Worksheet functions for materials

 

Class name

Class()

Class()

Layer name

Layer()

Layer()

Story name

Story()

Story()

Operators

Operators perform mathematical or logical operations with data, such as addition or comparison.

Operator

Description

+

Unary plus, Binary plus, Addition, Concatenation

-

Unary minus, Binary minus, Subtraction

*

Multiplication

/

Division

DIV

Integer division

MOD

Remainder division

=

Logical EQUALS

NOT

Logical NOT 

OR

Logical OR 

AND

Logical AND 

<>

Logical NOT EQUAL 

>

Greater than

<

Less than

>=

Greater than or equal

<=

Less than or equal

Data mapping examples

Creating or editing mapping formulas

Using the Data Manager

 

Was this page helpful?