Configuration objects

Production > Product Configurator > Product configurator definition > Configuration structure > Configuration objects

Top  Previous  Next
Expand/Collapse Toggles

The following object types can be added to the configuration structure:

configurator_sofa

Window artikel_produktkonfigurator.psr

 

Icon

Object type

Description

config_block

block

A block represents a grouping property within the configurator. Further objects can be subordinated to this. A block is visible in the navigation area of the configurator. Click to display the subordinate objects, such as parameters or dropdown lists at run time in the detail area. In our Sofa example the blocks are Design, Size, Covering and Color, Legs and Accessory which contain Sofa-relevant parameters with check boxes or drop-downs.
 

 
The following fields and properties are available:

Field

Description

Name

Item name (item number) After calling the configurator, this name is displayed at the top in the navigation area on the left

Picture

Select picture

Size

Define picture size

 

 

Field

Description

Long text

Field for additional text

Text 1

Field for additional text

Text 2

Field for additional text

Text 3

Field for additional text

 

 

Some rules can be defined to display the block with specific values or parameters. The rules determine whether a configuration option is presented to the operator, based on previous configuration selection. This way, it is possible to restrict options. The rule is created in SQL syntax.

Field

Description

Parameter Insert

Parameters and Set Objects that are already defined, are displayed in a selection list. They can be used to create of a rule.

Script

The language syntax that the rule is written in. Available options are:

DW Script
SQL formula
JavaScript formula
Java script
VBScript formula
VBScript

See Script Syntax

Input field

Insert the visible rule for the object. All defined parameters and Set-Objects can be used in the configuration.

 

Example:

[a] = 5

[color] = red

[a] > 5 or [b] = 3

 

To have a parameter not visible (maybe for special cases):

1 = 2

 

see Script Syntax

 

help-achtungNote:

When using the SQL formula, database accesses may reduce the performance of the configurator window.

The check button

Check for syntax errors in the entered script.

Flag

flaggreen – The rule is error free

flagyellow – Warning (default)

flagred – Error in rule

Result line

Shows the result of the evaluated rule.

Evaluation of the rule

Shows the evaluated rule with status message.

 

 

Tab "Extended"

Field

Description

Bitmap

to change the bitmap of the actual configuration object. Possible standard bitmaps via selection in the dropdown list

Color

set the color of text of the configuration object

 
 

notiz_weiss

Info

An Info-object displays a text and (optionally) an image in the detail area of the associated block. In our Sofa example, the info-object is Design – a full description of the product.

formelergebnis_weiss

Parameter

A Parameter is used to input or select the possible product options. In our Sofa example above the parameters are the Number seats, the color and the cover, the legs and accessories.

 

hmtoggle_plus1Parameter object details

A parameter (formelergebnis_weiss) is used for input or selection of possible options. You can access the value of the parameter, i.e. the selection you made, in the configurator within formulas/set objects.There are three possibilities:

oNormal:        Enter alphanumerical values
oCheckbox:        Select Yes/No
oSelection:        To a parameter of this type, selection objects need to be assigned (Separate objects, Radiobox or dropdown list).

 

The following fields and properties are available:

Field

Description

Parameter

Parameter name

Type

The Type of Parameter

Auto

Beas determines whether the parameter is a number or a string depending on the value.

If the value is a number or "0", Beas interprets this parameter as a number.
If the value is empty or not a number, Beas interprets this parameter as a string.

 

Example 1:

Parameter: "color" is "red"

Formula: 'the color is ' || [color]

HANA SQL: select 'the color is' || 'red' -> all ok

 

Formula: 10 + [color]

SQL: 10 + 'red' -> produce error

 

Example 2:

Parameter: "color" is "5.3"

 

Formula: 'the color is ' || [color]

HANA SQL: select 'the color is' || 5.3 -> produce error

 

Formula: 10 + [color]

SQL: 10 + 5.3 -> all ok

 

The evaluation of a formula is always dependent on the contents of the parameter.

All configurations created with beas 9.2 PL 5 Build 32 or older, use parameter type "Auto" as standard.

 

Working with Beas system variables or custom defined variables starting with "e_", the parameter can be interpreted as a string or number. With the following Beas script setup the type can be permanently defined as string type, if the value is a Beas variable. This must be executed only once per database or client.

setsetup=config_default_e_type=c

String

This parameter type allows a string. If working with formulas, Beas inserts a ‘ (single quotation mark) at the left and right side of the parameter.

If you create a new parameter, the string type is the default option.

 

Example 1:

Parameter: "color" is "red"

Formula: 'the color is ' || [color] (HANA SQL)

MS SQL: select 'the color is' + N'red'

HANA SQL: select 'the color is '  || ' red'

 

Example 2:

Parameter: "color_number" is "5,3"

Formula: '10' + [color_number]

MS SQL: '10' + '5,3' -> all ok

 

Formula: 'the color is ' + [color]

DataWindow Syntax: 'the color is' + 'red'

Number

This parameter type allows numbers only. If the content is not a number, Beas replaces it with “0”. The decimal delimiter is based on what it is defined in the system, but Beas internally replaces it with decimal point.

 

Example:

Parameter: "color_number" is "5,3" (Regional setting is Germany)

Formula: [color_number] * 3

SQL: 5.3 * 3

 

help-achtung

If you use a parameter both as a string or numeric value, then it is advantageous to specify this directly in the formula.

 

String formula: 'color is ' || [color,dbstring]

Number formula: if [color_number,dbnum] > 10 then 1 else 100 end

Name

Designation of Parameter

Picture

Select picture

Size

Definite picture size

 

 

Tab "Input"

Field

Description

Mandatory

If enabled, the parameter requires input, indicated by icon pk_cancel in the left navigation bar of the configurator window at runtime. The icon changes after editing the parameter. All mandatory parameters need to be edited, to have the complete block processed. icon changes to pk_ok).

Type of input

This defines how the input for a parameter has to be made. Possible settings are:

oNormal: Enter alphanumerical values
oNormal - large: Enter alphanumerical values to a large text field
oCheckbox: Select Yes/No
oSelection - Radiobox: Display as "Radiobox" List (Selection 1 out of n)
oSelection - Dropdown: Display as "Dropdown"-List (only possible if values will fetched via "Select"-Statement from Database!!)

Cross Reference

If type of input is selection, add an alternative to the parameter. You can access existing tables in Production > Product configurator > References. Saved references can be selected and will be available for selection in product configurator.

Default Value

If a default value is defined, this will be assigned to the parameter (Case sensitive!)

a) fix value

Text or numeric value (as required)

Example: test or 123

b) Variables, which are defined before opening in the Configurator window (e. g. with Beas Script in "Windowevent open"). These variables must be defined with "e_".

Example: [e_cardcode]

c) Previously defined parameters. These defaults are also changed dynamically

Example: [so_mysetobject]

 

Fixed value

 

A fixed value is set if

a) a new configuration is loaded

b) if a previously invalid default value becomes valid

 

When does an invalid default value become valid again?

 

This is explained in the following example:

 

Radio box with 3 elements: red, yellow, green.

The default value is yellow. But the visibility rule specifies that yellow is invisible and therefore invalid. In this case, "yellow" is not defined as the default value. There is no default.

Every time the configuration is changed, the system checks whether yellow is valid. If yes, this is set if the parameter has not yet been set otherwise.

 

The default is a parameter

 

If the default value is a parameter, it is always reset if something is changed before the parameter.

Example:

 

WheelSize

defcolor (set object): case when[WheelSize] <30 then 'red' else 'blue' end

Color (Default=[defcolor])

 

If WheelSize is changed, the content of Color is also reset because WheelSize is BEFORE Color. If values are changed after Color, Color is not set again.

 

Manual changes have priority:

 

If Color is changed manually, the manual change takes precedence, i.e. even if WheelSize is changed, the default value of Color is not reset.

Exception: the manually selected value loses its validity

 

Example:

 

Color is a radio box

// Red only available, if WheelSize < 30

// Blue only available, if WheelSize>24

Red = case when [WheelSize] <30 then 1 else 0 end

Blue= case when [WheelSize] >24 then 1 else 0 end

 

If you now manually select Blue and then set WheelSize to 22, Blue becomes invalid, so that manual entry loses its priority and the default value is set, in this case red and the entry is marked as "not changed manually".

If the default value is also invalid, the entry is marked as "not set".

 

 

Tab "Output"

Field

Description

Text

Definition of an output Text

 

 

 

Config_Object_Price

artikel_produktkonfigurator_detail

 

 

Field

Description

Price determination

 

Value

Description

Formula

Create a formula to calculate the price

Manually

Insert the price manually in the Price field

Price List

Use price from a Price List

- Use default price list, defined in Calculation Header

- Use a special price list from a customer, if it is activated in the Calculation Header

 

Supports all price list rules, but unit groups are not supported.

 

If you insert [cprice] in a formula, you see the price determination result by Price List in this parameter.

No

Price determination is not activated for this entry.

beas 9.3 PL 2

Price

Use the entered price, if price determination is set to Manually

Item

Choose the item directly or insert a parameter.

 

For example for the following sofa cushions there are two parameters:

- Cushions Yes/No: whether cushions are needed

- Number of quantity: how many cushions are needed

 

In Cushion we the price determination is set to No, so it does not affect the price.

In Number of Quantity we define the price by a price list.

 

Price comes from price list from "SofaCushion"  item that was added to the Item field.

Quantity comes from the current "Number of Cushions" parameter (nrcushion), so the [nrcushion] parameter is chosen in the Quantity field.

 

configurator_pricedetermination

 

Result:

Beas searches in the price list for the sofa cushion item.

 

Total Quantity = Quantity from Sales Order / Quotation * Quantity from [nrcushion]

Result = Price from Price List * Quantity from [nrcushion]

 

Use the Test button in the product configurator definition list to test the setup.

beas 9.3 PL 2

Quantity

 

Insert a number manually or use a parameter.

 

Two quantities are calculated:

Required quantity for 1 product (cquantity)

Required total quantity (calculated quantity * quantity from sales order = ctotalquantity)

 

For an example, see Item.

beas 9.3 PL 2

Script / Formula

If the price is calculated by a formula (Price determination is set to Formula), insert the formula.

The Parameter Insert field provides a shortcut to all available parameters.

 

If the "[price]" field is in the formula, Beas determines the price using the price list.

 

See Script Syntax

 

The following standard parameters are available

Parameter Name

Description

cprice

Price from a price list (only for the Price calculation field)

cpricequantity

Calculated quantity for this item (only for the Price calculation field)

cpricetotalquantity

Calculated quantity * Quantity from sales order / quotation (only for the Price calculation field)

cdiscount

Discount of the current business partner

cpricelist

Price list of the current business partner

currentuser

Current user

cardcode

Business partner from the sales order

cquantity

Quantity from the sales order

cdocdate

Date from the sales order in yyyy/mm/dd format

cshortvariant

Short variant A-Z

The check button

Check for syntax errors in the entered script

Flag

flaggreen – The rule is error free

flagyellow – Warning (default)

flagred – Error in rule

Result

Shows the result of the evaluated formula. The result must be a number.

Attention: Price determination by price list is not working here, [cprice] is always 0.

Evaluation of the rule

Shows the evaluated formula with a status message.

 

Some rules can be defined to display the block with specific values or parameters. The rules determine whether a configuration option is presented to the operator, based on previous configuration selection. This way, it is possible to restrict options. The rule is created in SQL syntax.

Field

Description

Parameter Insert

Parameters and Set Objects that are already defined, are displayed in a selection list. They can be used to create of a rule.

Script

The language syntax that the rule is written in. Available options are:

DW Script
SQL formula
JavaScript formula
Java script
VBScript formula
VBScript

See Script Syntax

Input field

Insert the visible rule for the object. All defined parameters and Set-Objects can be used in the configuration.

 

Example:

[a] = 5

[color] = red

[a] > 5 or [b] = 3

 

To have a parameter not visible (maybe for special cases):

1 = 2

 

see Script Syntax

 

help-achtungNote:

When using the SQL formula, database accesses may reduce the performance of the configurator window.

The check button

Check for syntax errors in the entered script.

Flag

flaggreen – The rule is error free

flagyellow – Warning (default)

flagred – Error in rule

Result line

Shows the result of the evaluated rule.

Evaluation of the rule

Shows the evaluated rule with status message.

 

 

Field

Description

Bitmap

Select the icon for the specific block. By default, Beas selects a folder icon.

Color

Select a display color for the text of the block name.

 

config_Selection

Selection

A Selection object is always allocated to a higher-level parameter. A selection object is displayed as a check box. The higher-level parameter then assumes the value allocated to the selection object when the check box is activated. In our Sofa example we have several selection objects allocated to each parameter. In the image above we can see "Armchair", "Two-seater" and "Three-seater" selection blocks that are available – which appear as check boxes in the test screen.

 

A selection object always refers to a superordinate parameter. The selection object is displayed as radiobox or drop-down list (only in case of an assigned reference).

The following fields and properties are available:

 

Field

Description

Parameter

Parameter name

Name

Designation of parameters

Picture

Select picture

Size

Definite picture size

 

Tab "Output"

Long text

Field for additional text

Text 1, Text 2, Text 3

Field for additional text

 

 

 

Config_Object_Price

artikel_produktkonfigurator_detail

 

 

Field

Description

Price determination

 

Value

Description

Formula

Create a formula to calculate the price

Manually

Insert the price manually in the Price field

Price List

Use price from a Price List

- Use default price list, defined in Calculation Header

- Use a special price list from a customer, if it is activated in the Calculation Header

 

Supports all price list rules, but unit groups are not supported.

 

If you insert [cprice] in a formula, you see the price determination result by Price List in this parameter.

No

Price determination is not activated for this entry.

beas 9.3 PL 2

Price

Use the entered price, if price determination is set to Manually

Item

Choose the item directly or insert a parameter.

 

For example for the following sofa cushions there are two parameters:

- Cushions Yes/No: whether cushions are needed

- Number of quantity: how many cushions are needed

 

In Cushion we the price determination is set to No, so it does not affect the price.

In Number of Quantity we define the price by a price list.

 

Price comes from price list from "SofaCushion"  item that was added to the Item field.

Quantity comes from the current "Number of Cushions" parameter (nrcushion), so the [nrcushion] parameter is chosen in the Quantity field.

 

configurator_pricedetermination

 

Result:

Beas searches in the price list for the sofa cushion item.

 

Total Quantity = Quantity from Sales Order / Quotation * Quantity from [nrcushion]

Result = Price from Price List * Quantity from [nrcushion]

 

Use the Test button in the product configurator definition list to test the setup.

beas 9.3 PL 2

Quantity

 

Insert a number manually or use a parameter.

 

Two quantities are calculated:

Required quantity for 1 product (cquantity)

Required total quantity (calculated quantity * quantity from sales order = ctotalquantity)

 

For an example, see Item.

beas 9.3 PL 2

Script / Formula

If the price is calculated by a formula (Price determination is set to Formula), insert the formula.

The Parameter Insert field provides a shortcut to all available parameters.

 

If the "[price]" field is in the formula, Beas determines the price using the price list.

 

See Script Syntax

 

The following standard parameters are available

Parameter Name

Description

cprice

Price from a price list (only for the Price calculation field)

cpricequantity

Calculated quantity for this item (only for the Price calculation field)

cpricetotalquantity

Calculated quantity * Quantity from sales order / quotation (only for the Price calculation field)

cdiscount

Discount of the current business partner

cpricelist

Price list of the current business partner

currentuser

Current user

cardcode

Business partner from the sales order

cquantity

Quantity from the sales order

cdocdate

Date from the sales order in yyyy/mm/dd format

cshortvariant

Short variant A-Z

The check button

Check for syntax errors in the entered script

Flag

flaggreen – The rule is error free

flagyellow – Warning (default)

flagred – Error in rule

Result

Shows the result of the evaluated formula. The result must be a number.

Attention: Price determination by price list is not working here, [cprice] is always 0.

Evaluation of the rule

Shows the evaluated formula with a status message.

 

 

 

Some rules can be defined to display the block with specific values or parameters. The rules determine whether a configuration option is presented to the operator, based on previous configuration selection. This way, it is possible to restrict options. The rule is created in SQL syntax.

Field

Description

Parameter Insert

Parameters and Set Objects that are already defined, are displayed in a selection list. They can be used to create of a rule.

Script

The language syntax that the rule is written in. Available options are:

DW Script
SQL formula
JavaScript formula
Java script
VBScript formula
VBScript

See Script Syntax

Input field

Insert the visible rule for the object. All defined parameters and Set-Objects can be used in the configuration.

 

Example:

[a] = 5

[color] = red

[a] > 5 or [b] = 3

 

To have a parameter not visible (maybe for special cases):

1 = 2

 

see Script Syntax

 

help-achtungNote:

When using the SQL formula, database accesses may reduce the performance of the configurator window.

The check button

Check for syntax errors in the entered script.

Flag

flaggreen – The rule is error free

flagyellow – Warning (default)

flagred – Error in rule

Result line

Shows the result of the evaluated rule.

Evaluation of the rule

Shows the evaluated rule with status message.

 

 

 

Field

Description

Bitmap

Select the icon for the specific block. By default, Beas selects a folder icon.

Color

Select a display color for the text of the block name.

 

config_Set

Set object

A Set object is a variable to which any values or formulas can be allocated. If a sofa is being configured, a set object so_length could be declared and the formula [numberofseats]*0.9 stored (where numberofseats can be the Name of a parameter or another Set object ). This parameter thus acquires the content of numberofseats – i.e. the value 1,2 or 3 in the example – multiplied by 0, The system can access the content of the set object within the configurator. A calculation by a database query can also come here. For this, the definition/query in the set object must start with "[select" and end with "]". See image above.

 

e.g. [select "Price" from "ITM1" where "PriceList"='basic price list']

 

Any variables must also be specified in square brackets in the Select instruction.

 

The following fields and properties are available:

 

Field

Description

Parameter

Object name

Parameter Type

The Type of Parameter

Auto

Beas determines whether the parameter is a number or a string depending on the value.

If the value is a number or "0", Beas interprets this parameter as a number.
If the value is empty or not a number, Beas interprets this parameter as a string.

 

Example 1:

Parameter: "color" is "red"

Formula: 'the color is ' || [color]

HANA SQL: select 'the color is' || 'red' -> all ok

 

Formula: 10 + [color]

SQL: 10 + 'red' -> produce error

 

Example 2:

Parameter: "color" is "5.3"

 

Formula: 'the color is ' || [color]

HANA SQL: select 'the color is' || 5.3 -> produce error

 

Formula: 10 + [color]

SQL: 10 + 5.3 -> all ok

 

The evaluation of a formula is always dependent on the contents of the parameter.

All configurations created with beas 9.2 PL 5 Build 32 or older, use parameter type "Auto" as standard.

 

Working with Beas system variables or custom defined variables starting with "e_", the parameter can be interpreted as a string or number. With the following Beas script setup the type can be permanently defined as string type, if the value is a Beas variable. This must be executed only once per database or client.

setsetup=config_default_e_type=c

String

This parameter type allows a string. If working with formulas, Beas inserts a ‘ (single quotation mark) at the left and right side of the parameter.

If you create a new parameter, the string type is the default option.

 

Example 1:

Parameter: "color" is "red"

Formula: 'the color is ' || [color] (HANA SQL)

MS SQL: select 'the color is' + N'red'

HANA SQL: select 'the color is '  || ' red'

 

Example 2:

Parameter: "color_number" is "5,3"

Formula: '10' + [color_number]

MS SQL: '10' + '5,3' -> all ok

 

Formula: 'the color is ' + [color]

DataWindow Syntax: 'the color is' + 'red'

Number

This parameter type allows numbers only. If the content is not a number, Beas replaces it with “0”. The decimal delimiter is based on what it is defined in the system, but Beas internally replaces it with decimal point.

 

Example:

Parameter: "color_number" is "5,3" (Regional setting is Germany)

Formula: [color_number] * 3

SQL: 5.3 * 3

 

help-achtung

If you use a parameter both as a string or numeric value, then it is advantageous to specify this directly in the formula.

 

String formula: 'color is ' || [color,dbstring]

Number formula: if [color_number,dbnum] > 10 then 1 else 100 end

Insert Parameter

Display all already defined parameters and set-objects. Makes easier to generate the description text for field below.

Script

Setup used syntax to define text of short designation

(SQL-Formula, JavaScript-Form, Java-Script, VBScript Formel, VBScript, DW Script)

See Script Syntax

 

help-achtungNote:

When using the SQL formula, database accesses may reduce the performance in the configurator window.

"Check"-Button

Used to check the formula, based on the set syntax

Flag

flaggreen - Rule is error free

flagyellow - Warning (default)

flagred - Error in rule

Result line

shows the result of the evaluated formula

Evaluation of the formula

shows the evaluated rule with status message

 

 

Field

Description

Bitmap

Select the icon for the specific block. By default, Beas selects a folder icon.

Color

Select a display color for the text of the block name.

 

kamera

Picture

An Info, Parameter and Selection can be assigned to a Picture. This is then displayed accordingly in the detail area.

 

hmtoggle_plus1Script Syntax

Different programming languages can be used in configurator Scripts.

All existing parameter, which has been defined in the configurator can be accessed via placeholder.

 

SQL Formula is set by default!

 

Please note:

Using the SQL formula, database access may reduce processing speed in the Configurator window.

 

 

Simplified use of SQL syntax only specifies what should be returned.

The system creates the following syntax:

 

select <your script> from "BEAS_DUMMY"

 

Example: Input: 3.5 * 4

It is executed: select 3.5 * 4 from "BEAS_DUMMY"

 

If an information from the product configurator is needed (from a parameter), these are enclosed in square brackets.

 

Example: [sofa_width] * 4

If the length is 300, following will be executed: select 300 * 4 from "BEAS_DUMMY"

 

    help-achtungPlease note:

    Since there are problems with different country settings (Database and/or Windows system)

    with decimal numbers and date definitions, should be used here with the formatting

    of parameters/set-objects (similar to Beas-Script) beas 9.2 PL: 05 (5.13)

 

    SQL conversions:  

    For numeric values [value,num] or date [date,dbdate] or string [stringparameter,dbstring]

 

    Example:

    [sofa_length,num] * 4   (with sofa_length: 200,5)

 

 

The whole SQL-instruction can be set in squared brackets if an extended SQL-instruction is necessary:

 

[select your command]

 

 

Example: Return UDF-Field: U_MaterialColor

[select "U_MaterialColor" from "OITM" where "ItemCode"=[my_itemcode,dbstring]]

 

Important: Do not forget the quotation marks at placeholder if it is about a reference

 

 

Example: Return of a price of a price list

 

[select "ITM1"."Price"

from "ITM1"

LEFT OUTER JOIN "OPLN" on "ITM1"."PriceList"="OPLN"."ListNum"

where "ITM1"."PriceList"="OPLN"."ListNum"

and "OPLN"."ListName"=[cpricelist,dbstring]

and "ITM1"."ItemCode"='stoff_blau']

 

 

Example: Visibility Rule

 

A selection element of a list should only be displayed if the parameter "cushions" has the content "Y":

 

[cushions] = 'Y'

 

 

Example: Assign a value (or text) to a Set object

 

If the content of the parameter "headrest" has the content "Y" then assign "Y", otherwise "N":

 

case when [headrest]='Y' then 'Y' else 'N' end

 

 

hmtoggle_plus1Product configuration process:

The procedure for creating a configurator for a product (item) is as follows:

Right-click on an existing object (or the empty configurator structure) to open a pop-up menu containing the objects to be added.

 

Configurator_right-click

Picture: Pop-up menu

 

 

Only the objects that can be added to the selected object are displayed. You can now select which object should be added; a new window opens in which you can define the properties of the object.

 

The system can access the "Set objects" and "Parameter" from Bill of materials positions and routing positions.

The Bill of materials and routings can thus be customized independently of variants.

 

 

help-hinweis

Note:

 

The names of the parameter and set-objects must be unique in the configuration structure. Not case sensitive.

 

The system can access the set-objects and Parameters from Bill of materials positions and routing positions

The Bill of materials and routings can thus be customized independently of variants.

 

Please note that for Parameters and Set-Objects, the following

reserved names cannot be used:

 

- cpreis

- cprice

- currentuser

- cpreisliste

- cpricelist

- crabatt

- cdiscount

 

It is similarly not allowed to use "e_" at the beginning of a Parameters or Set-Objects, because external variables start with it.

 

 


Help URL: https://help.beascloud.com/beas202102/index.html?konfigurationsobjekte.htm