Document toolboxDocument toolbox

Support center for flex.bi version 4.0

Advanced Settings for custom fields

You can use flex.bi advanced settings to add a measure, property or dimension for existing cubes in one of these cases:

  • Standard ERP fields that are not imported by flex.bi by default
  • additional data fields added to your Standard ERP installation using HAL
  • to modify import options for standard fields e.g. to import already supported field as a measure or even a separate dimension

Custom fields are supported from flex.bi version 5.0 and are supported only for import over REST API.

Limitations

Custom fields are supported for all data cubes except Financials (Transactions and Simulations registers), Job Costing (Projects and Project budgets registers), Stock Movements and Stock (Item History and Item Status registers). Please contact us if you have use cases for these cubes and we will work with you on a solution.

Additional custom fields

If you would like to import in flex.bi additional fields from a custom field that is not supported by default, then you can add a definition of how this custom field should be imported. Also, if some default custom field settings should be changed, then it can be done with adding necessary custom field configuration parameters.

1. Find the field name

First, you need to find out the register and REST API code for the field. You can find codes for registers in the HanasWorld source File import documentation page. Then you can use the code to find code for REST API field in HansaWorld Module Technics → Reports → Import/Export format

You can see in the example screenshot below the register code (1.) and codes for REST API fields (2.).

2. Find the correct Cube, Dimension and Level names

3. Configure custom field settings

Register code and register REST API code

[resgister_code.register_rest_api_code]

Where register_code is register code and register_rest_api_code is the register REST API code. This will start the block of configuration parameters for the custom field. 

Name for the custom field

A name for the field describing the logic in the most understandable for you way e.g.

name = "Price"

Cube Name

The cube name where the custom field will be available. You can find the full cube names in Analyze section in your flex.bi.

cube_name = "HansaWorld Invoices"

Dimension name in flex.bi for the register

Name of the dimension to which this field should be related to e.g. Invoices, Transactions, Quotations etc. Note that currently, this should be the main dimension of the cube e.g.

dimension_name = "Invoice"

Dimension level name

The name of the level within the specified dimension, where the field should be added, e,g.

level_name = "Invoice Item"

Data type of this field

One of the supported data types - integer, value, string e.g.

data_type = "string"

By default, the string maximum length is 255 characters. If there is a need to import longer string values, then use the additional limit setting to specify the maximum length.
Other available types are text, integerdecimal, datedatetime.

If you use the decimal data type, then by default the precision (maximum number of digits) is 15 and the scale (digits after the decimal point) is 2. You can change these defaults with the additional precision and scale settings.

Additional options

If you would like to import custom field as additional dimension then add

dimension = true

If you would like to import custom field as a measure then add

measure = true


Example of custom string type dimension definition

[IVVc.Price]
name = "Price"
cube_name = "HansaWorld Invoices"
data_type = "decimal"
level_name = "Invoice Item"
dimension_name = "Invoice"
measure = true
dimension = true

Add additional custom field definitions as needed in advanced settings text area field and then click Save.

3. Select custom fields for import

Edit the HansaWorld source application again, in "Cube properties" section select your new defined custom field for import and save the application.

4. Re-import data

To make sure that the historical data is also linked to the custom fields re-import the data.


In case of any questions please contact support@flex.bi for more information.