Using Component Parameters

How can I use Component Parameters?

For certain technical process components (XSL mappings, PDF Creator components and adapters), you can define component parameters in a process. 

As component parameters, you can use a set of parameters that are interpreted during process runtime.

These parameters can be set as values:

• system parameters, e. g. %PID% (current process ID) or %NOW% (current date and  time).
  For a complete list of available system parameters, see Overview of system parameters)

• global parameters (see Global Parameters)

• project parameters (see Project Parameters) 

Note

Observe the following prioritization when using component parameters and dynamic parameters:

• Component parameters overwrite the configuration of process components in the repository (for example, adapters) at runtime.

• Dynamic parameters overwrite set parameters and the configuration of process components in the repository (for example, adapters) at process runtime.

Defining Component Parameters

Proceed as follows to define component parameters:

1. Open the window Component Parameters:

   • In the technical process, select the process component to which you want to add a component parameter.

   • In the Properties view, click Component Parameters to display the button.

   • Click to open the window Component Parameters.
     

     

     
     

     The Component Parameters window opens.
     Here you can insert the name of the parameter in the Name field and the corresponding value in the Value field:
     

     

2. In Name, enter the name for the component parameter. 

   • For XSL mappings and reports: Enter the name for the component parameter. 
     You can retrieve these parameters as global XSL parameters, e. g. a global parameter PDFPath can be referenced by the XSL mapping with <xsl:param name="PDFPath"/>.
     

     

   • For adapters: In the Name field, click the dropdown.
     All available parameters of the adapter are displayed there for selection:
     

     

   • For database connections: Use the exact (technical) name of the parameter to be overwritten.

3. In Value, enter the parameter value to be overwritten during runtime.
   Here, you can insert parameters that will be replaced by current values during process runtime, e. g. %PID% is replaced by the current process ID.

Note:

Ctrl + Space will be display all available global, system and project parameters.

4. Click OK to save the component parameters in the process.

Note

If a component parameter is defined for a certain process component, the component is marked with a .

Available functions in window Component Parameters:

• Add: Create additional component parameters

• Remove: Delete a selected parameter from the list

• Up / Down: Change the parameter order in the list