Skip to main content

Parameters

Parameter definition​

Each parameter is basically structured according to the following scheme:

    <parameter name="">
        <displayName></displayName>
        <value></value>
        <visible>true</visible>
        <mandatory>true</mandatory>
    </parameter>

The name of the root-element defines the type of the created parameter (see "Parameter types" below). Each parameter gets a unique "name" attribute under which it is stored and can be used/referenced elsewhere in this Blueprint.

The child-element "displayName" contains the name to display on the userinterface. If this element is empty the parameter-name is used, if that is also empty a new UUID will be generated and displayed.

To specify a default value, the "value" element can be used but this is optional.

With "visible", you can set whether the parameter is visible on the GUI and whether it can be edited.

The "mandatory" element can be used to define whether a parameter is mandatory for the creation of the Blueprint, or it can be empty. If mandatory is set, the user can not run the Blueprint unless this parameter is set.

Parameter types​

systemprop​

A systemprop can read your systems properties.

    <systemprop name="">
        <displayName></displayName>
        <name></name>
    </systemprop>

With a parameter of this type you can get the users home-directory with "<name>user.home</name>", or the username with "<name>user.name</name>".

If this parameter is referenced, the system parameter is provided as a string.

model​

This parameter is used to select a concrete data model. "Type" must be specified as it is called in the project tree of the ADITO Designer (e.g.: "entity", "neonView", etc).

    <model>
        <type></type>
    </model>

If this parameter is referenced, the name of the model is provided as a string.

modelChildren​

This parameter reads all children from the given model and provides a list of all possible values to choose from.

    <modelChildren name="">
        <model></model>
        <container></container>
    </modelChildren>

The "container"-element has the following possible values:

  1. True → only container-properties are listed

  2. False → only primitive properties are listed

  3. null → all properties are listed

If the container element is not present, the functionality is the same as with the value "null".

If this parameter is referenced, the selected property is provided as string.

propertyValue​

This parameter provides the value of a property. If the property is primitive the simple value is provided and if the property is not primitive, all children are provided.

    <propertyValue name="">
        <model></model>
        <path></path>
    </propertyValue>

The "propertyValue"-parameter can have the following children:

  1. model → name of the model from which the properties are read

  2. path → path to the property

  3. childTypes (optional) → filter the children of the property by given type

If this parameter is referenced, and the property is primitive, the value is provided as string. If the property is not primitive, the children are provided as a list.

entityField​

References a specified entityField from an entity.

    <entityField>
        <entity></entity>
    </entityField>

Here the element "entity" specifies the name of the entity, from which the elements should be read out of.

If this parameter is referenced, the name of the entityField is provided as a string.

selection​

With the help of this type multiple values can be selected in form of checkboxes. The element "elements" specifies which values can be selected. Entries are separated by a "|" (pipe)

    <selection>
        <elements>a|b|c</elements>
    </selection>

If this parameter is referenced, the selection is provided as a list (see above).

dbalias​

This type provides the list of all alias definition with the type "database" that are configured in your project.

    <dbalias>
    </dbalias>

If this parameter is referenced, the name of the alias is provided as a string.

dbtable​

A "dbtable"-parameter provides a list of all tables of a specified alias.

    <dbtable>
        <alias></alias>
    </dbtable>

If this parameter is referenced, the selection is provided as a list (see above).

dbcolumn​

A "dbtable"-parameter provides a list of all columns of a specified alias and table.

    <dbcolumn>
        <alias></alias>
        <table></table>
    </dbcolumn>

If this parameter is referenced, the selection of columns with the table-name attached in front of it is provided as a list.

dbmeta​

Automatically contains all meta-information for the transferred tables. Tables are passed as a list.

    <dbmeta>
        <alias></alias>
        <tables></tables>
    </dbmeta>

A Parameter of this type contains the following keys:

  • dbmeta.TABLE.primaryKey → name of the primary key

  • dbmeta.TABLE.COLUMN.size → length of the column

  • dbmeta.TABLE.COLUMN.scale → scaling of the column

  • dbmeta.TABLE.COLUMN.nullable → indicates whether the column can be null or not

  • dbmeta.TABLE.COLUMN.unique → specifies whether the column is unique

  • dbmeta.TABLE.COLUMN.type → type of the column as it is defined in the AliasDefinition

If this parameter is referenced, the elements are provided as a map (see above).

unique​

This type creates a list of unique names from a data structure (map or list).

The ambiguous elements are referenced in "elements". This can either be a list or a map. If a map is used, "type" must be specified - possible values are "keys" or "values".

    <unique>
        <elements></elements>
        <type></type>
    </unique>

If this parameter is referenced, the unique values are provided as list (see above).

map​

With this type of parameter can be used to map 1:1 values. The values are transferred to "elements" using a map.

    <map>
        <elements></elements>
    </map>

If this parameter is referenced, the map is provided and mappings are automatically defined as variable (e.g.: ${map.ValueA}).

string​

The "string" type provides a simple string parameter, which can be easily referenced.

    <string>
        <value></value>
    </string>

If this parameter is referenced, the value is provided as a string.

stringConversion​

With a "stringConversion" it is possible to convert a list of elements to a desired type. To do this, each stringConversion-node has two child-nodes:

  1. elements
    → the list of elements that are to be converted

  2. type

    1. upper: all letters are converted to uppercase, example: "mytest" is converted to "MYTEST"

    2. lower: all letters are converted to lowercase, example: "MYTEST" is converted to "mytest"

    3. camel: tries the conversion to camelCase with the first letter as lowercase, example: "mytest" is converted to "myTest"

    4. camelFirst: tries the conversion to camelCase with the first letter as uppercase, example: "mytest" is converted to "MyTest"

    <stringConversion name="titleNames">
        <elements>mytest|myTest|MYTEST</elements>
        <type>upper</type>
    </stringConversion>

The usage of stringConversion is only possible from Version 2021.2 and above.