User-Defined Components

User-defined components allow you to create your own component series and use them in RFEM 6. In addition to the series provided in the Dlubal Center, company-specific design logics and detail designs can also be integrated.

Requirements

The following is required for creating and calculating user-defined components:

• Basic subscription of the Dlubal API
• Create API key in the Extranet
• Integrate API key in RFEM

Create API Key in the Extranet

1. Open Extranet
2. Navigate to API & Cloud → API II → My API Keys
3. Select Create new API key
4. Assign a name and generate the key
5. Save

Integrate API Key in RFEM

1. Open RFEM
2. Open the menu View → Console
3. Select Python | Dlubal API | gRPC
4. Select the key symbol
5. Enter the API key (name + key)
6. Confirm

The key is saved in a config.ini file.

Creating a User-defined Component

You can activate the input of a user-defined component as follows:

1. Open the Component Series dialog box.
2. Check the User-defined option.

This unlocks all input fields.

Activate custom option in dialog box

Categories (Metadata)

Setting Component Series | Base Tab | Categories

• Assignment type (e.g., object assignment)
• Manufacturer / new manufacturer
• Standards and output
• Function / category
• Material

Configuration Files (Files)

Setting Component Series | Base Tab | Configuration Files

1. Images

• Add any images or system sketches
• Purpose: visual representation of the component

2. Parameter Structure (JSON File)

• Grouping of the input structure
• Definition of the parameter assignment

Important Fields:

Additional groups can be added as desired.

Parameter structure for custom components

3. Parameter Data (Excel File)

• The data defines the parameter structure.
• Each row must have a unique name.
• The columns are freely definable, but must be used consistently.

4. Visualization (RFEM 6 File)

• Enables detailed visualization in the RFEM work window
• However, the component can also be created without a visualization file

Python Scripts (Script After Calculation)

Setting Component Series | Base Tab | Python Scripts

The script after the calculation controls the designs of the component.

Function: define_design_checks

• Definition of the design categories
• Type = display in RFEM (freely selectable)
• Description, category, and subcategory freely definable

Function: evaluate_single_check

• Transfer of the utilizations to RFEM

Function: setup_component_series_data()

• Execution of the design check
• Reading the parameters via properties_parameters
• The key must be identical to JSON and Excel
• Consistent type required between definition and evaluation

Save and Reuse Component in the Dlubal Center

You can save a user-defined component as a template to use it in other projects as well.

Proceed as follows:

1. In the Component Series dialog box, click the button at the bottom.
2. The 'Save Component Series' window appears with the suggested storage folder Documents → Dlubal Software → Component Series.
3. Specify a file name and then confirm with the Save button.

Save Custom Component

User-defined components are added in the Dlubal Center in the Component Series category. Under the entry Owner → User-defined, you can select the appropriate component there and assign it to a member.

Alternatively, use the button at the bottom of the Component Series dialog box to import the component from a file.