Hello!

Did you know that logged in users can see a lot more content?

US Custom Variables

Last updated November 30, 2018 by Tekla Structures Extensions USA solutions.us@tekla.com

Software version: 
Not version-specific
Environment: 
Not environment-specific
United States (Imperial)
United States (Metric)

US Custom Variables

1. Purpose and description

This set of custom variables extends the reporting capabilities of Tekla Structures. These variable are available throughout the system: reports, marks as templates, drawings, .Net API, filtering, object representationrepresentation of a model object or an object group in a model view, such a representation being based on the color and transparency settings applied to the model object or the object group

, etc…

2. System requirements

Environments: Any

Languages: ENGLISH

3. Installation

To install the application:

  1. Run the appropriate 32bit (x86) or 64bit (x64) USCustomVariables.msi installation file which is available in the Applications category (or as a search) of Tekla Warehouse.
  2. Have Tekla Structures closed during installation.
  3. Reopen Tekla Structures once installation is complete.

4. Usage

To use the application:

  1. You will need have the prefix “CUSTOM.” in front of each variable where used.
  2. Some of these variables rely on certain user defined attributes to be used that come with Tekla Structures usimp and usmet environments. These are specified for each case.
  3. The output of these variables will be default metric, the same as any other system template variables. The output can be customized using the template editortool in Tekla Structures used for creating and modifying templates to be used in drawings and reports

    formatting: E.g. Length -> ft-in -> 1/16”.
  4. These new variables are added to the contentattributes_custom_usa.lst under environments/usimp/template/settings/. If you are in other environments fine your contentattributes.lst and add new lines to include the copied files for these new lst files. Include this file in the contentattributes.lst file in the same folder as below:

4.1. Global Position

These variables read in the PROJ_DATUM_X, _Y, and _Z values automatically. These are designed so you can enter a project datum offset in the project properties user defined attributes once and it can be ready automatically for these variables helping you to avoid doing long, repetitive formulas and eliminating the need for you to model far from the origin to get the correct value in reports and drawings for positions.

Name

Type

Row Type

Description

CUSTOM.GLOBAL_START_X

Distance

Part

Start offset for part X

CUSTOM.GLOBAL_START_Y

Distance

Part

Start offset for part Y

CUSTOM.GLOBAL_START_Z

Distance

Part

Start offset for part Z

CUSTOM.GLOBAL_END_X

Distance

Part

End offset for part X

CUSTOM.GLOBAL_END_Y

Distance

Part

End offset for part Y

CUSTOM.GLOBAL_END_Z

Distance

Part

End offset for part Z

CUSTOM.GLOBAL_COG_X

Distance

Part

Global Cog X

CUSTOM.GLOBAL_COG_Y

Distance

Part

Global Cog Y

CUSTOM.GLOBAL_COG_Z

Distance

Part

Global Cog Z

***All variables in this section expect to be run only on part type objects in the model.

4.2. Local Position

These are not using any global offsets. Some of these values are not available in the templates normally, others save you long, repetitive formulas to get the values you need.

Name

Type

Row Type

Description

CUSTOM.LOCAL_COG_X

Distance

Part

Local Cog X*

CUSTOM.LOCAL_COG_Y

Distance

Part

Local Cog Y*

CUSTOM.LOCAL_COG_Z

Distance

Part

Local Cog Z*

CUSTOM.AT_DEPTH_OFFSET

Distance

Part

Profile depth offset value

CUSTOM.AT_DEPTH

String

Part

Profile depth enum (MIDDLE, FRONT, BEHIND)

CUSTOM.ON_PLANE_OFFSET

Distance

Part

Profile on plane offset value

CUSTOM.ON_PLANE

String

Part

Profile on plane enum (MIDDLE, LEFT, RIGHT)

CUSTOM.ROTATION_OFFSET

Distance

Part

Profile rotation offset value

CUSTOM.ROTATION

String

Part

Profile rotation enum (FRONT, TOP, BACK, BELOW)

CUSTOM.START_DX

Distance

Part

Profile start handle x offset

CUSTOM.START_DY

Distance

Part

Profile start handle y offset

CUSTOM.START_DZ

Distance

Part

Profile start handle z offset

CUSTOM.END_DX

Distance

Part

Profile end handle x offset

CUSTOM.END_DY

Distance

Part

Profile end handle y offset

CUSTOM.END_DZ

Distance

Part

Profile end handle z offset

*These variables are relative to the exact center (calculated by extrema’s) of the start relative end of the part and are limited to part type objects in the model.
***All variables in this section expect to be run only on part type objects in the model.

4.3. Non Specific

Name

Type

Row Type

Description

CUSTOM.HANDLE_LENGTH

Distance

Part

Beam is input object, returns distance from start handle to end handle in 3d space

CUSTOM.COMPONENT_NAME

String Component Works for any component (plugin, custom component, system component) - Gets class Name field value
CUSTOM.HAS_ANYCUTS Integer Part Returns 1 if part has cuts of any type
CUSTOM.HAS_LINECUTS Integer Part Returns 1 if part has line cuts
CUSTOM.HAS_EDGECHAMFERS Integer Part Returns 1 if part has edge chamfers
CUSTOM.HAS_ANYPARTCUTS Integer Part Returns 1 if part has any part type cuts
CUSTOM.HAS_FITTINGS Integer Part Returns 1 if part has fittings

4.4. Concrete Specific

Name

Type

Row Type

Description

CUSTOM.SLAB_PERIMETER_AREA

Area

Part

Summation of vertical edge face area for part and any sub parts

CUSTOM.SLAB_PERIMETER

Distance

Part

Summation of length around vertical edge faces of part

CUSTOM.ASSEMBLY_WEIGHT

Weight

Cast Unit

Weight of concrete assembly accounting secondary parts, reinforcement, bolts, and welds. Assumes sub-assemblies are exterior to Cast Unit. Does not remove displaced concrete weight of steel sub-assemblies prior to 2017 release version. 

CUSTOM.ASSEMBLY_VOLUME

Volume

Cast Unit

Volume of concrete assembly accounting for secondary parts, reinforcement, bolts, and welds. Does not remove displaced concrete volume of steel sub-assemblies prior to 2017 release version. 

CUSTOM.CONCRETE_WEIGHT

Weight

Cast Unit

Weight of concrete parts in assembly accounting secondary parts, reinforcement, bolts, and welds. Removes displaced concrete weight.

CUSTOM.CONCRETE_VOLUME

Volume

Cast Unit

Volume of concrete parts in assembly accounting for secondary parts, reinforcement, bolts, and welds. Removes displaced concrete volume.

***All variables in this section expect to be run only on concrete part type objects in the model.

4.5. Rebar Specific

Name

Type

Row Type

Description

CUSTOM.LENGTH_AJSUM

Distance

Rebar

Summation of A through G leg values with the start and end uda offsets added*

CUSTOM.LENGTH_AJ

Distance

Rebar

Actual length of the rebar along centerline with the start and end uda offsets added*

CUSTOM.WEIGHT_AJSUM

Weight

Rebar

Theoretical weight using the Summation length of A through G multiplied by weight per unit length with the associated weight of the start and end uda offsets added*

CUSTOM.WEIGHT_AJ

Weight

Rebar

Actual weight of the rebar along centerline multiplied by weight per unit length with the associated weight of the start and end uda offsets added*

CUSTOM.CREATION_METHOD

Integer

RebarGoup

SPACING_TYPE_UNDEFINED = 0

SPACING_TYPE_EXACT_SPACINGS = 1

SPACING_TYPE_EXACT_NUMBER = 2

SPACING_TYPE_TARGET_SPACE = 3

SPACING_TYPE_EXACT_SPACE_FLEX_AT_START = 4

SPACING_TYPE_EXACT_SPACE_FLEX_AT_END = 5

SPACING_TYPE_EXACT_SPACE_FLEX_AT_BOTH = 6

SPACING_TYPE_EXACT_SPACE_FLEX_AT_MIDDLE = 7

CUSTOM.REINF_VOLUME

Volume

Assembly

Volume of reinforcement in assembly, sub-assemblies, and secondary parts. Includes all reinforcement types.

CUSTOM.REINF_WEIGHT

Weight

Assembly

Weight of reinforcement in assembly, sub-assemblies, and secondary parts. Includes all reinforcement types.

CUSTOM.MESH_VOLUME

Volume

Assembly

Volume of mesh reinforcement in assembly, sub-assemblies, and secondary parts.

CUSTOM.MESH_WEIGHT

Weight

Assembly

Weight of mesh reinforcement in assembly, sub-assemblies, and secondary parts.

CUSTOM.STRAND_VOLUME

Volume

Assembly

Volume of strand reinforcement in assembly, sub-assemblies, and secondary parts.

CUSTOM.STRAND_WEIGHT

Weight

Assembly

Weight of strand reinforcement in assembly, sub-assemblies, and secondary parts.

CUSTOM.REBAR_VOLUME

Volume

Assembly

Volume of rebar in assembly, sub-assemblies, and secondary parts.

CUSTOM.REBAR_WEIGHT

Weight

Assembly

Weight of rebar in assembly, sub-assemblies, and secondary parts.

CUSTOM.CC_TARGET

Distance RebarGroup CC_TARGET in distance type format

CUSTOM.CC_MIN

Distance RebarGroup CC_MIN in distance type format

CUSTOM.CC_MAX

Distance RebarGroup CC_MAX in distance type format

CUSTOM.REBAR_DENSITY1

lbs/yd3 Cast Unit/Part Rebar density factor - Weight of rebar / Volume of Concrete

CUSTOM.REBAR_DENSITY2

lbs/ft3 Cast Unit/Part Rebar density factor - Weight of rebar / Volume of Concrete
CUSTOM.IS_SINGLE_RADIUS Integer Rebar Returns 1 if there is only one radius value for bar bends
CUSTOM.IS_TAPERED Integer RebarGroup Returns 1 if group type is tapered group
CUSTOM.IS_PLANAR Integer Rebar Returns 1 if all bar geometry is on the same 3d geometric plane
CUSTOM.NUMBER_BENDS Integer Rebar Returns integer count number for bends required to create bar
CUSTOM.IS_HEAVY Integer Rebar Returns 1 if bar is classified as 'heavy' bend type
CUSTOM.HAS_START_HOOK Integer Rebar Returns 1 if bar has start end hook
CUSTOM.HAS_END_HOOK Integer Rebar Returns 1 if bar has finish end hook
CUSTOM.IS_STD_STARTHOOK Integer Rebar Returns 1 if bar start hook is standard radius and length for angle per rebar catalog setup
CUSTOM.IS_STD_ENDHOOK Integer Rebar Returns 1 if bar end hook is standard radius and length for angle per rebar catalog setup
CUSTOM.IS_STD_RADIUS Integer Rebar Returns 1 if main bar bending radius is standard value per rebar catalog setup
CUSTOM.STD_RADIUS Distance Rebar Returns mm value for standard radius of bar per rebar catalog setup
CUSTOM.LEN_AJSUM_FFIIQ String Rebar Imperial formatted theoretical length in (ft-ft-in-in-qtr) format string
CUSTOM.LEN_AJ_FFIIQ String Rebar Imperial formatted actual length (ft-ft-in-in-qtr)
CUSTOM.LEN_AJSUM_FFFFII String Rebar Imperial formatted theoretical length in (ft-ft-ft-ft-in-in) format string
CUSTOM.LEN_AJ_FFFFII String Rebar Imperial formatted actual length (ft-ft-ft-ft-in-in)
CUSTOM.LEN_AJSUM_FFII String Rebar Imperial formatted theoretical length in (ft-ft-in-in) format string
CUSTOM.LEN_AJ_FFII String Rebar Imperial formatted actual length (ft-ft-in-in)

*OFFSET_START and OFFSET_END are length adjustment fields added to reinforcement default out of the box that are intended to represent the difference in the fabricated and placed on site state. If the bar needs to be longer pre-fabricated then put a positive value the corresponding udaobject property created by the user in order to widen the range of predefined object properties

User-defined attributes are used when the predefined object properties are not sufficient but more properties are needed. For example, comment, locked, and erection status are user-defined attributes.

field. For group rebar, the length fields are summed to account for quantity, execpt for tapered which returns 0.0.
**Weight per unit length is pulled from the “rebar_database.inp” tables automatically.
***All variables in this section expect to be run only on reinforcement type objects in the model.

4.6. Steel Specific

Name

Type

Row Type

Description

CUSTOM.EXACT_WEIGHT

Weight

Part

The weight taken from the profile weight per unit length multiplied by length in the model minus the difference in the weight gross and net. Works for part type objects.

CUSTOM.IS_HARDWAY

Integer

Part

Intended for polybeams only. Returns 1 if beam is bent along flange, 0 otherwise.

CUSTOM.IS_HOLE

Integer

Part

Intended for bolt group objects only. Returns 1 if bolt hole element, 0 if bolt type element;

CUSTOM.PROFILE_PREFIX

String

Part

Returns the profile alpha characters in the profile string. E.g. PL1/4*6” => PL

CUSTOM.PIPE_CIRCUMFERENCE

Distance

Part

Intended for parts with circular hollow tube profiles. Gives the circumference at centerline.

CUSTOM.TUBE_INSIDE_LENGTH

Distance Part Measures tube inside length

CUSTOM.HAS_PARTCUTS

Integer

Part

Checks if part has polygon or part type cuts on it. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_COPES

Integer

Part

Checks part solid to see if it has any copes. Copes are defined as a flange cut 1” back from end of fitted end on top or bottom at any end. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_BEVELS

Integer

Part

Checks the report properties (ENDx_SKEW) for each end to see if it has true value. Returns 1 if true if either end has skew value, 0 if neither do. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_HOLES

Integer

Part

Checks part for any bolt hole elements. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_WELDS

Integer

Part

Checks part for welds, shop or field. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_SHOP_WELDS

Integer

Part

Checks part for shop welds. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_FIELD_WELDS

Integer

Part

Checks part for field welds. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_BOLTS

Integer

Part

Checks part for any bolt elements that are not bolt standard “STUD”, field or workshop. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_SHOP_BOLTS

Integer

Part

Checks part for any shop type bolt elements. Ignores stud type bolts. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_FIELD_BOLTS

Integer

Part

Checks part for any field type bolt elements. Ignores stud type bolts. Returns 1 if true, 0 otherwise.

CUSTOM.HAS_STUDS

 

Part

Checks part for bolt type elements with bolt standard set to “STUD”. Returns 1 if true, 0 otherwise.

CUSTOM.TOPCHORD_LENGTH

Distance

Part

Designed for assemblies made of built up plates where main part is first contour plate designating the angle of the built up section. Measures along the top of the contour plate along length of assembly where it intersects end plates

CUSTOM.SLOPE_ANGLE

Angle

Part

Angle of slope in degrees part local x axis and global xy plane

CUSTOM.SAW_CUT_LENGTH

Distance

Part

Measures max distance along beam along its axis from edge apparent intersection points

CUSTOM.ASSEMBLY_WEIGHT

Weight

Assembly

Weight of steel assembly including secondary parts, sub-assembliies, reinforcement, bolts, and welds.

CUSTOM.ASSEMBLY_VOLUME

Volume

Assembly

Volume of steel assembly including secondary parts, sub-assembliies, reinforcement, bolts, and welds.

CUSTOM.BOLT_VOLUME

Volume

Assembly

Volume of bolts in assembly, sub-assemblies, and secondary parts.

CUSTOM.BOLT_WEIGHT

Weight

Assembly

Weight of bolts in assembly, sub-assemblies, and secondary parts.

CUSTOM.WELD_VOLUME

Volume

Assembly

Volume of welds in assembly, sub-assemblies, and secondary parts.

CUSTOM.WELD_WEIGHT

Weight

Assembly

Weight of welds in assembly, sub-assemblies, and secondary parts.

CUSTOM.CENTER_X

Distance BoltGroup Bolt group center position - x component

CUSTOM.CENTER_Y

Distance BoltGroup Bolt group center position - y component

CUSTOM.CENTER_Z

Distance BoltGroup Bolt group center position - z component (half the height of the bolt hole)

CUSTOM.SPACING_X

String BoltGroup Distance list of x bolt spacing values

CUSTOM.SPACING_Y

String BoltGroup Distance list of y bolt spacing values

4.7. Drawing Properties

Note: These variables only work if drawing is open and current.

Name

Type

Row Type

Description

CUSTOM.DRAWING_MARK

String

Drawing

Works on any type drawing. Retrieves the mark without the “[“ or “]”

CUSTOM.SHEET_TOTAL

Integer

Drawing

Intended for cast unit drawings only. Returns the number of other drawings of the same part as current drawing. This is useful when creating more than one drawing of a castunit and need sheet x/y where “y” is the number given by this variable.

CUSTOM.DG_REBAR_TOTAL

Weight

Drawing

Provides a summation of the rebar weight for a drawing.

5. Limitations and Important Notes

  1. Drawing properties only work on open, current drawings. These are not available for report templatetemplate that is used for creating a report

    use.

  2. Some areas of Tekla Structures functionality give strings always for these type values, for example filtering, but the values should be there and usable.

6. Changes

September 20th 2017: Version 1.0 - TSEP for 2017i and up
Added Fields for rebar:
1. CUSTOM.IS_SINGLE_RADIUS
3. CUSTOM.NUMBER_BENDS
5. CUSTOM.HAS_START_HOOK
6. CUSTOM.HAS_END_HOOK
7. CUSTOM.IS_STD_STARTHOOK
8. CUSTOM.IS_STD_ENDHOOK
9. CUSTOM.IS_STD_RADIUS
10. CUSTOM.STD_RADIUS
11. CUSTOM.LEN_AJSUM_FFIIQ
12. CUSTOM.LEN_AJ_FFIIQ
13. CUSTOM.LEN_AJSUM_FFFII
14. CUSTOM.LEN_AJ_FFFII
15. CUSTOM.LEN_AJSUM_FFII
16. CUSTOM.LEN_AJ_FFII
17. CUSTOM.IS_PLANAR

Added Fields for parts:
1. CUSTOM.HAS_ANYCUTS
2. CUSTOM.HAS_LINECUTS
3. CUSTOM.HAS_EDGECHAMFERS
4. CUSTOM.HAS_PARTCUTS
5. CUSTOM.HAS_FITTINGS

October 6th, 2017:
Fixes issue where variables weren't working in selection filters.

December 6th, 2016: 2016 and 2016i V3 released:
Fixes issue with CUSTOM.SLOPE_ANGLE not working correctly if view planeplane in a space that defines the view

In Tekla Structures, the grids are projected onto the view plane and the grid lines can be visible on it.

View depth is defined starting from the view plane.

wasn't set to global UCSlocal coordinate system defined by the user and used in a drawing view

User coordinate system makes it easier to place drawing objects, because the user can place the drawing objects relative to a user-definable point of origin, or a base point in the drawing view.

Tekla Structures displays the user coordinate system symbol in the current drawing view when the user creates, copies, moves, or modifies drawing objects.

November 28th, 2016: Updated V2 installers for 2016, 2016i released:
Fixes null exception error that occurs after installing 2016 SP2 or 2016i SP1

September 13th, 2016:
Installer for 2016i V1 released

March 14th, 2016:
Version 2016 V1 released

June 26th, 2017: (2016 v4, 2016i v4, 2017 v2)
Added Fields:
1. CUSTOM.CC_TARGET
2. CUSTOM.CC_MIN
3. CUSTOM.CC_MAX
4. CUSTOM.CENTER_X
5. CUSTOM.CENTER_Y
6. CUSTOM.CENTER_Z
7. CUSTOM.SPACING_X
8. CUSTOM.SPACING_Y
9. CUSTOM.REBAR_DENSITY1
10. CUSTOM.REBAR_DENSITY2
11. CUSTOM.COMPONENT_NAME

Fixed incorrect calculation for formularule stated in a mathematical language

Formula is part of an equation.

:
CUSTOM.SLOPE_ANGLE

Quick feedback

The feedback you give here is not visible to other users. We use your comments to improve our documentation.
We use this to prevent automated spam submissions.
Content rating: 
No votes yet