Parameter Store
Starting with Intrexx version 12.0.0
The Parameter Store is a central repository that allows non-sensitive connection parameters (e.g., hosts, ports, usernames) used in processes (e.g., in IMAP event sources or generic elements) to be stored independently of those processes and made available at runtime.
This feature is required for managing processes in public Git repositories and for sharing processes with third parties. The parameter storage enables an improved staging environment from the test environment to the production environment.
You can find the parameter storage in the "Integration" module on the left, below the "Connection Data Management" entry. When you click on it, the parameters defined in the portal are listed in the right-hand pane, along with their name, value, description, and date of the last change.
In the upper-right corner, you'll find the " 
" button, "Add Parameter." Clicking on it opens a dialog box where you can create new parameters.
Create Parameter
The parameter name and value are required here; a description may be entered optionally. The parameter name must be unique and may contain only the following characters: [a-z][A-Za-z0-9]*.
Click "OK" to save the changes and close the dialog box.
"Edit Parameters"
Opens a dialog box where you can edit the parameter currently selected in the list.
Edit Parameters
The name of the parameter cannot be changed. The value and description can be edited. Click "OK" to save the changes and close the dialog box.
The changes are applied immediately and are available during the execution of processes. Exception: If the value of a parameter changes, processes with event sources that use that parameter must be republished.
Remove Parameter
Deletes the parameter currently selected in the list. When removing a parameter, the system checks whether the selected parameter is used in any processes. If so, the system will prompt you to confirm whether you still want to delete the parameter.
View Usage in Intrexx
Opens a dialog box that displays the processes that use the parameter.
Use in Intrexx
This checks which processes use the selected parameter. The processes found are displayed in a list.
Click "OK" to save the changes and close the dialog box.
Search field
Above the parameter table in the right-hand pane, you'll find a search field. The table is filtered by parameters whose names contain the search term.
Refresh
You can reload the parameter list from the server via the "Parameter Memory / Refresh" option in the main menu or by clicking the corresponding " 
" button on the toolbar.
parameterstore.cfg
All parameters are stored in the XML file "parameterstore.cfg" in the portal directory "internal/cfg". Here's an example:
<?xml version="1.0" encoding="UTF-8"?>
<parameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.intrexx.com/intrexx/2024/parameter-store/ http://schemas.unitedplanet.de/intrexx/2024/package/de/uplanet/lucy/server/parameterstore/cfg/res/parameterstore.xsd"/>
<parameter name="myHost" lastModified="2024-04-15T13:32:51.320Z" value="test.example.org">
<description>Host für Testsystem</description>
</parameter>
<parameter name="myPort" lastModified="2024-04-15T13:33:39.181Z" value="993">
<description>Port für Testsystem</description>
</parameter>
<parameter name="myUser" lastModified="2024-04-15T13:34:20.375Z" value="testUser">
<description>Benutzername für Testsystem</description>
</parameter>
</parameters>Parameters in Process Elements
In the "Processes" module, parameters can be selected at various points in the properties of process elements; they can also be created and saved in the parameter memory. Alternatively, the parameters can also be saved directly within the process.
A parameter is stored in a separate bean property whose name consists of the name of the bean property for the static value followed by the suffix “ParamRef.” The value of the Bean property corresponds to the name of the parameter that was assigned in the Parameter Store. Example: userParamRef = "myUser".
IMAP Event Source (Type: "Standard IMAP")
For the IMAP event source, you can specify the IMAP server, IMAP port, and username in the element's properties on the "Email Server" tab.
If you click on the small downward-pointing arrow on the right, a menu opens where you can choose whether the respective value should be saved with the process (default) or retrieved from the parameter store.If you select "From Parameter Store," the corresponding input field will become a drop-down list from which you can select the desired parameter. The name of the parameter is then stored in the process.
If you have selected the "From Parameter Storage" menu, the icon to the right of the "IMAP Server," "IMAP Port," or "Username" fields will change to a different 
symbol. Clicking on each one opens a dialog box where you can edit existing parameters and create new ones.
Select Parameter
All existing parameters are listed here. By clicking "Add Parameter" at , you can create new parameters and edit existing ones from here.
Show only parameters with integer values
When selecting parameters for the IMAP port, you'll also find the setting "Show only parameters with integer values."
Only parameters with an integer value are available for the IMAP port. If you disable the "Show only parameters with integer values" setting, all parameters will be displayed. However, only parameters with integer values can be selected.
IMAP Event Source (Type "Exchange Online")
Here, the client, user principal name, and application ID can be specified or selected in the same way as for the IMAP event source of type "Standard IMAP. "
Generic Elements
When editing a property, if the property has the suffix "ParamRef," you can select a parameter by clicking " " ("Insert value from parameter"). In the runtime class, the "@Referenceable" annotation must be applied to the setter and getter of the bean property for the static value.
@Referenceable
public String getUser()
{
return m_strUser;
}
@Referenceable
public void setUser(String p_strUser)
{
m_strUser = p_strUser;
}
public String getUserParamRef()
{
return m_strUserParamRef;
}
public void setUserParamRef(String p_strParamRef)
{
m_strUserParamRef = p_strParamRef;
}"Expert" tab
Using parameters via the "Expert" tab in the properties of process elements works in the same way as for generic elements.
Groovy API
The context object "g_parameterReferences" is available for accessing the parameter store. You can find more information here.
Security
The following measures are in place to ensure the security of the parameter store:
-
Permissions Check: To add, edit, or remove parameters, users need the portal permission "Change Portal Properties"; to view or select parameters, they need the portal permission "Change Portal Properties," access to the "Applications" module, or access to the "Processes" module.
-
When exporting a process, only the parameter names are exported; no values are included. During or after the process import, the user can reset the values if they have the necessary portal permissions.
Publication of Proceedings
Check for Undefined Parameters
Before a process is published, the system checks whether the parameters used in the process are defined in the portal. During this process, the bean properties of the elements and the Groovy scripts are checked.
Undefined parameters may occur in a process—for example, if an imported process contains a parameter that does not exist in the current portal. If there are any undefined parameters in the process, a corresponding message will be displayed, which also points out potential problems that may arise when publishing or executing the process. The user has the option to continue or cancel the publication.
In the element properties, undefined parameters are marked with the suffix (undefined) (exception: generic elements and the "Expert" tab).
Notes Tab
In addition to the warning message, the "Warnings" section lists the relevant elements and, if applicable, Groovy script files. When you hover over the warning triangle, the entry's description appears.
Double-clicking an element highlights it on the workspace.
Groovy script files can also be displayed. Double-clicking the corresponding entry opens the script editor. The cursor jumps to the line where an undefined parameter is first used.
metaParameter.xml
When publishing, the parameter names used in the process are written to the new "metaParameter.xml" file in the process directory. The parameter names are collected from the "model.xml" file and from files with the ".groovy" extension.
<meta xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.intrexx.com/intrexx/2024/meta/parameter/ http://schemas.unitedplanet.de/intrexx/2024/package/de/uplanet/lucy/parameterstore/meta/res/metaparameter.xsd">
<parameter name="myHost"/>
<parameter name="myPort"/>
<parameter name="myUser"/>
</meta>
Process Import
If a parameter is used in at least one of the processes selected for import, the new "Parameters" page will appear in the Import Wizard.
The names of the parameters from the selected processes are displayed here. The source of the names is the "metaParameter.xml" file in each case.
In the first column of the parameter list, click " 
" "Info" to view its usage in the import package. The parameter name is displayed in the second column.
In the third column, you'll find a checkbox that allows you to create a new parameter if it doesn't already exist in the target portal.
Configure Parameters
Clicking "Configure Parameters" at 
opens a dialog box where you can configure the new parameter. When creating a new entry, the parameter must be configured; that is, a value must be entered. The parameter name must be unique and may contain only the following characters: [a-z][A-Za-z0-9]*. Optionally, you can also enter a description.
If the checkbox is selected and the new parameter is configured, it will be added to the parameter store during the import process.
To create new parameters, you need the "Change Portal Properties" portal permission.
The fourth column shows whether there is an assignment for the parameter from the portal's parameter store. The mapping occurs automatically if a parameter with the same name as the one in the import package exists in the portal. It is not possible to assign a different name, because its use in Groovy scripts cannot be determined with 100% certainty, and therefore it would not always be possible to adjust the name.
Alternatively, missing parameters can also be added immediately to the portal's parameter store. To do this, open the Parameter Store by clicking the "Open Parameter Store" button. You can find more information here.
When you close the dialog box, the mappings to the portal are updated.
If not all parameters have been assigned or the creation of new parameters has not been fully configured, a warning message will appear when you click "Next." The import can still be continued upon request.